<!DOCTYPE html>

<html lang="en">
<head>
	<meta charset="utf-8">
	<meta name="viewport" content="width=device-width">
	<title>Phaser 3 API Documentation - Class: Camera</title>
	<!--[if lt IE 9]>
	<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
	<![endif]-->
	<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
	<link type="text/css" rel="stylesheet" href="styles/site.cerulean.css">
	<link type="text/css" rel="stylesheet" href="styles/search.loading.css" />
</head>

<body>

<div class="navbar navbar-default navbar-fixed-top ">
<div class="container">
	<div class="navbar-header">
		<a class="navbar-brand" href="index.html"><img class="branding-logo" src="img/phaser3-logo-nav.png"
		alt="Phaser 3 logo" title="Phaser 3" /></a>
		<button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
			<span class="icon-bar"></span>
			<span class="icon-bar"></span>
			<span class="icon-bar"></span>
        </button>
	</div>
	<div class="navbar-collapse collapse" id="topNavigation">
		<ul class="nav navbar-nav">
			
			<li class="dropdown">
				<a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b class="caret"></b></a>
				<ul class="dropdown-menu ">
					<li><a href="Phaser.html">Phaser</a></li><li><a href="Phaser.Actions.html">Phaser.Actions</a></li><li><a href="Phaser.Animations.html">Phaser.Animations</a></li><li><a href="Phaser.Animations.Events.html">Phaser.Animations.Events</a></li><li><a href="Phaser.BlendModes.html">Phaser.BlendModes</a></li><li><a href="Phaser.Cache.html">Phaser.Cache</a></li><li><a href="Phaser.Cache.Events.html">Phaser.Cache.Events</a></li><li><a href="Phaser.Cameras.html">Phaser.Cameras</a></li><li><a href="Phaser.Cameras.Controls.html">Phaser.Cameras.Controls</a></li><li><a href="Phaser.Cameras.Scene2D.html">Phaser.Cameras.Scene2D</a></li><li><a href="Phaser.Cameras.Scene2D.Effects.html">Phaser.Cameras.Scene2D.Effects</a></li><li><a href="Phaser.Cameras.Scene2D.Events.html">Phaser.Cameras.Scene2D.Events</a></li><li><a href="Phaser.Cameras.Sprite3D.html">Phaser.Cameras.Sprite3D</a></li><li><a href="Phaser.Core.html">Phaser.Core</a></li><li><a href="Phaser.Core.Events.html">Phaser.Core.Events</a></li><li><a href="Phaser.Create.html">Phaser.Create</a></li><li><a href="Phaser.Create.Palettes.html">Phaser.Create.Palettes</a></li><li><a href="Phaser.Curves.html">Phaser.Curves</a></li><li><a href="Phaser.Data.html">Phaser.Data</a></li><li><a href="Phaser.Data.Events.html">Phaser.Data.Events</a></li><li><a href="Phaser.Device.html">Phaser.Device</a></li><li><a href="Phaser.Display.html">Phaser.Display</a></li><li><a href="Phaser.Display.Align.html">Phaser.Display.Align</a></li><li><a href="Phaser.Display.Align.In.html">Phaser.Display.Align.In</a></li><li><a href="Phaser.Display.Align.To.html">Phaser.Display.Align.To</a></li><li><a href="Phaser.Display.Bounds.html">Phaser.Display.Bounds</a></li><li><a href="Phaser.Display.Canvas.html">Phaser.Display.Canvas</a></li><li><a href="Phaser.Display.Canvas.CanvasInterpolation.html">Phaser.Display.Canvas.CanvasInterpolation</a></li><li><a href="Phaser.Display.Canvas.CanvasPool.html">Phaser.Display.Canvas.CanvasPool</a></li><li><a href="Phaser.Display.Canvas.Smoothing.html">Phaser.Display.Canvas.Smoothing</a></li><li><a href="Phaser.Display.Color.Interpolate.html">Phaser.Display.Color.Interpolate</a></li><li><a href="Phaser.Display.Masks.html">Phaser.Display.Masks</a></li><li><a href="Phaser.DOM.html">Phaser.DOM</a></li><li><a href="Phaser.Events.html">Phaser.Events</a></li><li><a href="Phaser.GameObjects.html">Phaser.GameObjects</a></li><li><a href="Phaser.GameObjects.Components.html">Phaser.GameObjects.Components</a></li><li><a href="Phaser.GameObjects.Components.Alpha.html">Phaser.GameObjects.Components.Alpha</a></li><li><a href="Phaser.GameObjects.Components.AlphaSingle.html">Phaser.GameObjects.Components.AlphaSingle</a></li><li><a href="Phaser.GameObjects.Components.BlendMode.html">Phaser.GameObjects.Components.BlendMode</a></li><li><a href="Phaser.GameObjects.Components.ComputedSize.html">Phaser.GameObjects.Components.ComputedSize</a></li><li><a href="Phaser.GameObjects.Components.Crop.html">Phaser.GameObjects.Components.Crop</a></li><li><a href="Phaser.GameObjects.Components.Depth.html">Phaser.GameObjects.Components.Depth</a></li><li><a href="Phaser.GameObjects.Components.Flip.html">Phaser.GameObjects.Components.Flip</a></li><li><a href="Phaser.GameObjects.Components.GetBounds.html">Phaser.GameObjects.Components.GetBounds</a></li><li><a href="Phaser.GameObjects.Components.Mask.html">Phaser.GameObjects.Components.Mask</a></li><li><a href="Phaser.GameObjects.Components.Origin.html">Phaser.GameObjects.Components.Origin</a></li><li><a href="Phaser.GameObjects.Components.PathFollower.html">Phaser.GameObjects.Components.PathFollower</a></li><li><a href="Phaser.GameObjects.Components.Pipeline.html">Phaser.GameObjects.Components.Pipeline</a></li><li><a href="Phaser.GameObjects.Components.ScrollFactor.html">Phaser.GameObjects.Components.ScrollFactor</a></li><li><a href="Phaser.GameObjects.Components.Size.html">Phaser.GameObjects.Components.Size</a></li><li><a href="Phaser.GameObjects.Components.Texture.html">Phaser.GameObjects.Components.Texture</a></li><li><a href="Phaser.GameObjects.Components.TextureCrop.html">Phaser.GameObjects.Components.TextureCrop</a></li><li><a href="Phaser.GameObjects.Components.Tint.html">Phaser.GameObjects.Components.Tint</a></li><li><a href="Phaser.GameObjects.Components.Transform.html">Phaser.GameObjects.Components.Transform</a></li><li><a href="Phaser.GameObjects.Components.Visible.html">Phaser.GameObjects.Components.Visible</a></li><li><a href="Phaser.GameObjects.Events.html">Phaser.GameObjects.Events</a></li><li><a href="Phaser.GameObjects.Particles.html">Phaser.GameObjects.Particles</a></li><li><a href="Phaser.GameObjects.Particles.Zones.html">Phaser.GameObjects.Particles.Zones</a></li><li><a href="Phaser.GameObjects.RetroFont.html">Phaser.GameObjects.RetroFont</a></li><li><a href="Phaser.Geom.html">Phaser.Geom</a></li><li><a href="Phaser.Geom.Intersects.html">Phaser.Geom.Intersects</a></li><li><a href="Phaser.Input.html">Phaser.Input</a></li><li><a href="Phaser.Input.Events.html">Phaser.Input.Events</a></li><li><a href="Phaser.Input.Gamepad.html">Phaser.Input.Gamepad</a></li><li><a href="Phaser.Input.Gamepad.Configs.html">Phaser.Input.Gamepad.Configs</a></li><li><a href="Phaser.Input.Gamepad.Events.html">Phaser.Input.Gamepad.Events</a></li><li><a href="Phaser.Input.InputPluginCache.html">Phaser.Input.InputPluginCache</a></li><li><a href="Phaser.Input.Keyboard.html">Phaser.Input.Keyboard</a></li><li><a href="Phaser.Input.Keyboard.Events.html">Phaser.Input.Keyboard.Events</a></li><li><a href="Phaser.Input.Keyboard.KeyCodes.html">Phaser.Input.Keyboard.KeyCodes</a></li><li><a href="Phaser.Input.Mouse.html">Phaser.Input.Mouse</a></li><li><a href="Phaser.Input.Touch.html">Phaser.Input.Touch</a></li><li><a href="Phaser.Loader.html">Phaser.Loader</a></li><li><a href="Phaser.Loader.Events.html">Phaser.Loader.Events</a></li><li><a href="Phaser.Loader.FileTypes.html">Phaser.Loader.FileTypes</a></li><li><a href="Phaser.Loader.FileTypesManager.html">Phaser.Loader.FileTypesManager</a></li><li><a href="Phaser.Math.html">Phaser.Math</a></li><li><a href="Phaser.Math.Angle.html">Phaser.Math.Angle</a></li><li><a href="Phaser.Math.Distance.html">Phaser.Math.Distance</a></li><li><a href="Phaser.Math.Easing.html">Phaser.Math.Easing</a></li><li><a href="Phaser.Math.Easing.Back.html">Phaser.Math.Easing.Back</a></li><li><a href="Phaser.Math.Easing.Bounce.html">Phaser.Math.Easing.Bounce</a></li><li><a href="Phaser.Math.Easing.Circular.html">Phaser.Math.Easing.Circular</a></li><li><a href="Phaser.Math.Easing.Cubic.html">Phaser.Math.Easing.Cubic</a></li><li><a href="Phaser.Math.Easing.Elastic.html">Phaser.Math.Easing.Elastic</a></li><li><a href="Phaser.Math.Easing.Expo.html">Phaser.Math.Easing.Expo</a></li><li><a href="Phaser.Math.Easing.Quadratic.html">Phaser.Math.Easing.Quadratic</a></li><li><a href="Phaser.Math.Easing.Quartic.html">Phaser.Math.Easing.Quartic</a></li><li><a href="Phaser.Math.Easing.Quintic.html">Phaser.Math.Easing.Quintic</a></li><li><a href="Phaser.Math.Easing.Sine.html">Phaser.Math.Easing.Sine</a></li><li><a href="Phaser.Math.Easing.html#.Stepped">Phaser.Math.Easing.Stepped</a></li><li><a href="Phaser.Math.Fuzzy.html">Phaser.Math.Fuzzy</a></li><li><a href="Phaser.Math.Interpolation.html">Phaser.Math.Interpolation</a></li><li><a href="Phaser.Math.Pow2.html">Phaser.Math.Pow2</a></li><li><a href="Phaser.Math.Snap.html">Phaser.Math.Snap</a></li><li><a href="Phaser.Physics.html">Phaser.Physics</a></li><li><a href="Phaser.Physics.Arcade.html">Phaser.Physics.Arcade</a></li><li><a href="Phaser.Physics.Arcade.Components.html">Phaser.Physics.Arcade.Components</a></li><li><a href="Phaser.Physics.Arcade.Components.Acceleration.html">Phaser.Physics.Arcade.Components.Acceleration</a></li><li><a href="Phaser.Physics.Arcade.Components.Angular.html">Phaser.Physics.Arcade.Components.Angular</a></li><li><a href="Phaser.Physics.Arcade.Components.Bounce.html">Phaser.Physics.Arcade.Components.Bounce</a></li><li><a href="Phaser.Physics.Arcade.Components.Debug.html">Phaser.Physics.Arcade.Components.Debug</a></li><li><a href="Phaser.Physics.Arcade.Components.Drag.html">Phaser.Physics.Arcade.Components.Drag</a></li><li><a href="Phaser.Physics.Arcade.Components.Enable.html">Phaser.Physics.Arcade.Components.Enable</a></li><li><a href="Phaser.Physics.Arcade.Components.Friction.html">Phaser.Physics.Arcade.Components.Friction</a></li><li><a href="Phaser.Physics.Arcade.Components.Gravity.html">Phaser.Physics.Arcade.Components.Gravity</a></li><li><a href="Phaser.Physics.Arcade.Components.Immovable.html">Phaser.Physics.Arcade.Components.Immovable</a></li><li><a href="Phaser.Physics.Arcade.Components.Mass.html">Phaser.Physics.Arcade.Components.Mass</a></li><li><a href="Phaser.Physics.Arcade.Components.Size.html">Phaser.Physics.Arcade.Components.Size</a></li><li><a href="Phaser.Physics.Arcade.Components.Velocity.html">Phaser.Physics.Arcade.Components.Velocity</a></li><li><a href="Phaser.Physics.Arcade.Events.html">Phaser.Physics.Arcade.Events</a></li><li><a href="Phaser.Physics.Arcade.Tilemap.html">Phaser.Physics.Arcade.Tilemap</a></li><li><a href="Phaser.Physics.Matter.html">Phaser.Physics.Matter</a></li><li><a href="Phaser.Physics.Matter.Components.html">Phaser.Physics.Matter.Components</a></li><li><a href="Phaser.Physics.Matter.Components.Bounce.html">Phaser.Physics.Matter.Components.Bounce</a></li><li><a href="Phaser.Physics.Matter.Components.Collision.html">Phaser.Physics.Matter.Components.Collision</a></li><li><a href="Phaser.Physics.Matter.Components.Force.html">Phaser.Physics.Matter.Components.Force</a></li><li><a href="Phaser.Physics.Matter.Components.Friction.html">Phaser.Physics.Matter.Components.Friction</a></li><li><a href="Phaser.Physics.Matter.Components.Gravity.html">Phaser.Physics.Matter.Components.Gravity</a></li><li><a href="Phaser.Physics.Matter.Components.Mass.html">Phaser.Physics.Matter.Components.Mass</a></li><li><a href="Phaser.Physics.Matter.Components.Sensor.html">Phaser.Physics.Matter.Components.Sensor</a></li><li><a href="Phaser.Physics.Matter.Components.SetBody.html">Phaser.Physics.Matter.Components.SetBody</a></li><li><a href="Phaser.Physics.Matter.Components.Sleep.html">Phaser.Physics.Matter.Components.Sleep</a></li><li><a href="Phaser.Physics.Matter.Components.Static.html">Phaser.Physics.Matter.Components.Static</a></li><li><a href="Phaser.Physics.Matter.Components.Transform.html">Phaser.Physics.Matter.Components.Transform</a></li><li><a href="Phaser.Physics.Matter.Components.Velocity.html">Phaser.Physics.Matter.Components.Velocity</a></li><li><a href="Phaser.Physics.Matter.Events.html">Phaser.Physics.Matter.Events</a></li><li><a href="Phaser.Physics.Matter.Matter.html">Phaser.Physics.Matter.Matter</a></li><li><a href="Phaser.Physics.Matter.PhysicsEditorParser.html">Phaser.Physics.Matter.PhysicsEditorParser</a></li><li><a href="Phaser.Physics.Matter.PhysicsJSONParser.html">Phaser.Physics.Matter.PhysicsJSONParser</a></li><li><a href="Phaser.Plugins.html">Phaser.Plugins</a></li><li><a href="Phaser.Plugins.PluginCache.html">Phaser.Plugins.PluginCache</a></li><li><a href="Phaser.Renderer.html">Phaser.Renderer</a></li><li><a href="Phaser.Renderer.Canvas.html">Phaser.Renderer.Canvas</a></li><li><a href="Phaser.Renderer.Snapshot.html">Phaser.Renderer.Snapshot</a></li><li><a href="Phaser.Renderer.WebGL.html">Phaser.Renderer.WebGL</a></li><li><a href="Phaser.Renderer.WebGL.Pipelines.html">Phaser.Renderer.WebGL.Pipelines</a></li><li><a href="Phaser.Renderer.WebGL.Pipelines.ModelViewProjection.html">Phaser.Renderer.WebGL.Pipelines.ModelViewProjection</a></li><li><a href="Phaser.Renderer.WebGL.Utils.html">Phaser.Renderer.WebGL.Utils</a></li><li><a href="Phaser.Scale.html">Phaser.Scale</a></li><li><a href="Phaser.Scale.Center.html">Phaser.Scale.Center</a></li><li><a href="Phaser.Scale.Events.html">Phaser.Scale.Events</a></li><li><a href="Phaser.Scale.Orientation.html">Phaser.Scale.Orientation</a></li><li><a href="Phaser.Scale.ScaleModes.html">Phaser.Scale.ScaleModes</a></li><li><a href="Phaser.Scale.Zoom.html">Phaser.Scale.Zoom</a></li><li><a href="Phaser.ScaleModes.html">Phaser.ScaleModes</a></li><li><a href="Phaser.Scenes.html">Phaser.Scenes</a></li><li><a href="Phaser.Scenes.Events.html">Phaser.Scenes.Events</a></li><li><a href="Phaser.Scenes.Settings.html">Phaser.Scenes.Settings</a></li><li><a href="Phaser.Sound.html">Phaser.Sound</a></li><li><a href="Phaser.Sound.Events.html">Phaser.Sound.Events</a></li><li><a href="Phaser.Structs.html">Phaser.Structs</a></li><li><a href="Phaser.Structs.Events.html">Phaser.Structs.Events</a></li><li><a href="Phaser.Textures.html">Phaser.Textures</a></li><li><a href="Phaser.Textures.Events.html">Phaser.Textures.Events</a></li><li><a href="Phaser.Textures.FilterMode.html">Phaser.Textures.FilterMode</a></li><li><a href="Phaser.Textures.Parsers.html">Phaser.Textures.Parsers</a></li><li><a href="Phaser.Tilemaps.html">Phaser.Tilemaps</a></li><li><a href="Phaser.Tilemaps.Components.html">Phaser.Tilemaps.Components</a></li><li><a href="Phaser.Tilemaps.Formats.html">Phaser.Tilemaps.Formats</a></li><li><a href="Phaser.Tilemaps.Parsers.html">Phaser.Tilemaps.Parsers</a></li><li><a href="Phaser.Tilemaps.Parsers.Impact.html">Phaser.Tilemaps.Parsers.Impact</a></li><li><a href="Phaser.Tilemaps.Parsers.Tiled.html">Phaser.Tilemaps.Parsers.Tiled</a></li><li><a href="Phaser.Time.html">Phaser.Time</a></li><li><a href="Phaser.Tweens.html">Phaser.Tweens</a></li><li><a href="Phaser.Tweens.Builders.html">Phaser.Tweens.Builders</a></li><li><a href="Phaser.Tweens.Events.html">Phaser.Tweens.Events</a></li><li><a href="Phaser.Types.html">Phaser.Types</a></li><li><a href="Phaser.Types.Actions.html">Phaser.Types.Actions</a></li><li><a href="Phaser.Types.Animations.html">Phaser.Types.Animations</a></li><li><a href="Phaser.Types.Cameras.html">Phaser.Types.Cameras</a></li><li><a href="Phaser.Types.Cameras.Controls.html">Phaser.Types.Cameras.Controls</a></li><li><a href="Phaser.Types.Cameras.Scene2D.html">Phaser.Types.Cameras.Scene2D</a></li><li><a href="Phaser.Types.Core.html">Phaser.Types.Core</a></li><li><a href="Phaser.Types.Create.html">Phaser.Types.Create</a></li><li><a href="Phaser.Types.Curves.html">Phaser.Types.Curves</a></li><li><a href="Phaser.Types.Display.html">Phaser.Types.Display</a></li><li><a href="Phaser.Types.GameObjects.html">Phaser.Types.GameObjects</a></li><li><a href="Phaser.Types.GameObjects.BitmapText.html">Phaser.Types.GameObjects.BitmapText</a></li><li><a href="Phaser.Types.GameObjects.Graphics.html">Phaser.Types.GameObjects.Graphics</a></li><li><a href="Phaser.Types.GameObjects.Group.html">Phaser.Types.GameObjects.Group</a></li><li><a href="Phaser.Types.GameObjects.Particles.html">Phaser.Types.GameObjects.Particles</a></li><li><a href="Phaser.Types.GameObjects.PathFollower.html">Phaser.Types.GameObjects.PathFollower</a></li><li><a href="Phaser.Types.GameObjects.RenderTexture.html">Phaser.Types.GameObjects.RenderTexture</a></li><li><a href="Phaser.Types.GameObjects.Sprite.html">Phaser.Types.GameObjects.Sprite</a></li><li><a href="Phaser.Types.GameObjects.Text.html">Phaser.Types.GameObjects.Text</a></li><li><a href="Phaser.Types.GameObjects.TileSprite.html">Phaser.Types.GameObjects.TileSprite</a></li><li><a href="Phaser.Types.Input.html">Phaser.Types.Input</a></li><li><a href="Phaser.Types.Input.Gamepad.html">Phaser.Types.Input.Gamepad</a></li><li><a href="Phaser.Types.Input.Keyboard.html">Phaser.Types.Input.Keyboard</a></li><li><a href="Phaser.Types.Loader.html">Phaser.Types.Loader</a></li><li><a href="Phaser.Types.Loader.FileTypes.html">Phaser.Types.Loader.FileTypes</a></li><li><a href="Phaser.Types.Math.html">Phaser.Types.Math</a></li><li><a href="Phaser.Types.Physics.html">Phaser.Types.Physics</a></li><li><a href="Phaser.Types.Physics.Arcade.html">Phaser.Types.Physics.Arcade</a></li><li><a href="Phaser.Types.Physics.Matter.html">Phaser.Types.Physics.Matter</a></li><li><a href="Phaser.Types.Plugins.html">Phaser.Types.Plugins</a></li><li><a href="Phaser.Types.Renderer.html">Phaser.Types.Renderer</a></li><li><a href="Phaser.Types.Renderer.Snapshot.html">Phaser.Types.Renderer.Snapshot</a></li><li><a href="Phaser.Types.Scenes.html">Phaser.Types.Scenes</a></li><li><a href="Phaser.Types.Sound.html">Phaser.Types.Sound</a></li><li><a href="Phaser.Types.Textures.html">Phaser.Types.Textures</a></li><li><a href="Phaser.Types.Tilemaps.html">Phaser.Types.Tilemaps</a></li><li><a href="Phaser.Types.Time.html">Phaser.Types.Time</a></li><li><a href="Phaser.Types.Tweens.html">Phaser.Types.Tweens</a></li><li><a href="Phaser.Utils.html">Phaser.Utils</a></li><li><a href="Phaser.Utils.Array.html">Phaser.Utils.Array</a></li><li><a href="Phaser.Utils.Array.Matrix.html">Phaser.Utils.Array.Matrix</a></li><li><a href="Phaser.Utils.Array.StableSortFunctions.html">Phaser.Utils.Array.StableSortFunctions</a></li><li><a href="Phaser.Utils.Base64.html">Phaser.Utils.Base64</a></li><li><a href="Phaser.Utils.Objects.html">Phaser.Utils.Objects</a></li><li><a href="Phaser.Utils.String.html">Phaser.Utils.String</a></li><li><a href="SpinePluginEvents.html">SpinePluginEvents</a></li>
				</ul>
			</li>
			
			<li class="dropdown">
				<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a>
				<ul class="dropdown-menu ">
					<li><a href="Camera3DPlugin.html">Camera3DPlugin</a></li><li><a href="global.html#Class">Class</a></li><li><a href="Phaser.Animations.Animation.html">Phaser.Animations.Animation</a></li><li><a href="Phaser.Animations.AnimationFrame.html">Phaser.Animations.AnimationFrame</a></li><li><a href="Phaser.Animations.AnimationManager.html">Phaser.Animations.AnimationManager</a></li><li><a href="Phaser.Cache.BaseCache.html">Phaser.Cache.BaseCache</a></li><li><a href="Phaser.Cache.CacheManager.html">Phaser.Cache.CacheManager</a></li><li><a href="Phaser.Cameras.Controls.FixedKeyControl.html">Phaser.Cameras.Controls.FixedKeyControl</a></li><li><a href="Phaser.Cameras.Controls.SmoothedKeyControl.html">Phaser.Cameras.Controls.SmoothedKeyControl</a></li><li><a href="Phaser.Cameras.Scene2D.BaseCamera.html">Phaser.Cameras.Scene2D.BaseCamera</a></li><li><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></li><li><a href="Phaser.Cameras.Scene2D.CameraManager.html">Phaser.Cameras.Scene2D.CameraManager</a></li><li><a href="Phaser.Cameras.Scene2D.Effects.Fade.html">Phaser.Cameras.Scene2D.Effects.Fade</a></li><li><a href="Phaser.Cameras.Scene2D.Effects.Flash.html">Phaser.Cameras.Scene2D.Effects.Flash</a></li><li><a href="Phaser.Cameras.Scene2D.Effects.Pan.html">Phaser.Cameras.Scene2D.Effects.Pan</a></li><li><a href="Phaser.Cameras.Scene2D.Effects.RotateTo.html">Phaser.Cameras.Scene2D.Effects.RotateTo</a></li><li><a href="Phaser.Cameras.Scene2D.Effects.Shake.html">Phaser.Cameras.Scene2D.Effects.Shake</a></li><li><a href="Phaser.Cameras.Scene2D.Effects.Zoom.html">Phaser.Cameras.Scene2D.Effects.Zoom</a></li><li><a href="Phaser.Cameras.Sprite3D.Camera.html">Phaser.Cameras.Sprite3D.Camera</a></li><li><a href="Phaser.Cameras.Sprite3D.CameraManager.html">Phaser.Cameras.Sprite3D.CameraManager</a></li><li><a href="Phaser.Cameras.Sprite3D.OrthographicCamera.html">Phaser.Cameras.Sprite3D.OrthographicCamera</a></li><li><a href="Phaser.Cameras.Sprite3D.PerspectiveCamera.html">Phaser.Cameras.Sprite3D.PerspectiveCamera</a></li><li><a href="Phaser.Core.Config.html">Phaser.Core.Config</a></li><li><a href="Phaser.Core.TimeStep.html">Phaser.Core.TimeStep</a></li><li><a href="Phaser.Curves.CubicBezier.html">Phaser.Curves.CubicBezier</a></li><li><a href="Phaser.Curves.Curve.html">Phaser.Curves.Curve</a></li><li><a href="Phaser.Curves.Ellipse.html">Phaser.Curves.Ellipse</a></li><li><a href="Phaser.Curves.Line.html">Phaser.Curves.Line</a></li><li><a href="Phaser.Curves.MoveTo.html">Phaser.Curves.MoveTo</a></li><li><a href="Phaser.Curves.Path.html">Phaser.Curves.Path</a></li><li><a href="Phaser.Curves.QuadraticBezier.html">Phaser.Curves.QuadraticBezier</a></li><li><a href="Phaser.Curves.Spline.html">Phaser.Curves.Spline</a></li><li><a href="Phaser.Data.DataManager.html">Phaser.Data.DataManager</a></li><li><a href="Phaser.Data.DataManagerPlugin.html">Phaser.Data.DataManagerPlugin</a></li><li><a href="Phaser.Display.BaseShader.html">Phaser.Display.BaseShader</a></li><li><a href="Phaser.Display.Color.html">Phaser.Display.Color</a></li><li><a href="Phaser.Display.Masks.BitmapMask.html">Phaser.Display.Masks.BitmapMask</a></li><li><a href="Phaser.Display.Masks.GeometryMask.html">Phaser.Display.Masks.GeometryMask</a></li><li><a href="Phaser.DOM.RequestAnimationFrame.html">Phaser.DOM.RequestAnimationFrame</a></li><li><a href="Phaser.Events.EventEmitter.html">Phaser.Events.EventEmitter</a></li><li><a href="Phaser.FacebookInstantGamesLeaderboard.html">Phaser.FacebookInstantGamesLeaderboard</a></li><li><a href="Phaser.FacebookInstantGamesPlugin.html">Phaser.FacebookInstantGamesPlugin</a></li><li><a href="Phaser.Game.html">Phaser.Game</a></li><li><a href="Phaser.GameObjects.Arc.html">Phaser.GameObjects.Arc</a></li><li><a href="Phaser.GameObjects.BitmapText.html">Phaser.GameObjects.BitmapText</a></li><li><a href="Phaser.GameObjects.Blitter.html">Phaser.GameObjects.Blitter</a></li><li><a href="Phaser.GameObjects.Bob.html">Phaser.GameObjects.Bob</a></li><li><a href="Phaser.GameObjects.Components.Animation.html">Phaser.GameObjects.Components.Animation</a></li><li><a href="Phaser.GameObjects.Components.TransformMatrix.html">Phaser.GameObjects.Components.TransformMatrix</a></li><li><a href="Phaser.GameObjects.Container.html">Phaser.GameObjects.Container</a></li><li><a href="Phaser.GameObjects.Curve.html">Phaser.GameObjects.Curve</a></li><li><a href="Phaser.GameObjects.DisplayList.html">Phaser.GameObjects.DisplayList</a></li><li><a href="Phaser.GameObjects.DOMElement.html">Phaser.GameObjects.DOMElement</a></li><li><a href="Phaser.GameObjects.DynamicBitmapText.html">Phaser.GameObjects.DynamicBitmapText</a></li><li><a href="Phaser.GameObjects.Ellipse.html">Phaser.GameObjects.Ellipse</a></li><li><a href="Phaser.GameObjects.Extern.html">Phaser.GameObjects.Extern</a></li><li><a href="Phaser.GameObjects.GameObject.html">Phaser.GameObjects.GameObject</a></li><li><a href="Phaser.GameObjects.GameObjectCreator.html">Phaser.GameObjects.GameObjectCreator</a></li><li><a href="Phaser.GameObjects.GameObjectFactory.html">Phaser.GameObjects.GameObjectFactory</a></li><li><a href="Phaser.GameObjects.Graphics.html">Phaser.GameObjects.Graphics</a></li><li><a href="Phaser.GameObjects.Grid.html">Phaser.GameObjects.Grid</a></li><li><a href="Phaser.GameObjects.Group.html">Phaser.GameObjects.Group</a></li><li><a href="Phaser.GameObjects.Image.html">Phaser.GameObjects.Image</a></li><li><a href="Phaser.GameObjects.IsoBox.html">Phaser.GameObjects.IsoBox</a></li><li><a href="Phaser.GameObjects.IsoTriangle.html">Phaser.GameObjects.IsoTriangle</a></li><li><a href="Phaser.GameObjects.Light.html">Phaser.GameObjects.Light</a></li><li><a href="Phaser.GameObjects.LightsManager.html">Phaser.GameObjects.LightsManager</a></li><li><a href="Phaser.GameObjects.LightsPlugin.html">Phaser.GameObjects.LightsPlugin</a></li><li><a href="Phaser.GameObjects.Line.html">Phaser.GameObjects.Line</a></li><li><a href="Phaser.GameObjects.Mesh.html">Phaser.GameObjects.Mesh</a></li><li><a href="Phaser.GameObjects.Particles.EmitterOp.html">Phaser.GameObjects.Particles.EmitterOp</a></li><li><a href="Phaser.GameObjects.Particles.GravityWell.html">Phaser.GameObjects.Particles.GravityWell</a></li><li><a href="Phaser.GameObjects.Particles.Particle.html">Phaser.GameObjects.Particles.Particle</a></li><li><a href="Phaser.GameObjects.Particles.ParticleEmitter.html">Phaser.GameObjects.Particles.ParticleEmitter</a></li><li><a href="Phaser.GameObjects.Particles.ParticleEmitterManager.html">Phaser.GameObjects.Particles.ParticleEmitterManager</a></li><li><a href="Phaser.GameObjects.Particles.Zones.DeathZone.html">Phaser.GameObjects.Particles.Zones.DeathZone</a></li><li><a href="Phaser.GameObjects.Particles.Zones.EdgeZone.html">Phaser.GameObjects.Particles.Zones.EdgeZone</a></li><li><a href="Phaser.GameObjects.Particles.Zones.RandomZone.html">Phaser.GameObjects.Particles.Zones.RandomZone</a></li><li><a href="Phaser.GameObjects.PathFollower.html">Phaser.GameObjects.PathFollower</a></li><li><a href="Phaser.GameObjects.Polygon.html">Phaser.GameObjects.Polygon</a></li><li><a href="Phaser.GameObjects.Quad.html">Phaser.GameObjects.Quad</a></li><li><a href="Phaser.GameObjects.Rectangle.html">Phaser.GameObjects.Rectangle</a></li><li><a href="Phaser.GameObjects.RenderTexture.html">Phaser.GameObjects.RenderTexture</a></li><li><a href="Phaser.GameObjects.Rope.html">Phaser.GameObjects.Rope</a></li><li><a href="Phaser.GameObjects.Shader.html">Phaser.GameObjects.Shader</a></li><li><a href="Phaser.GameObjects.Shape.html">Phaser.GameObjects.Shape</a></li><li><a href="Phaser.GameObjects.Sprite.html">Phaser.GameObjects.Sprite</a></li><li><a href="Phaser.GameObjects.Sprite3D.html">Phaser.GameObjects.Sprite3D</a></li><li><a href="Phaser.GameObjects.Star.html">Phaser.GameObjects.Star</a></li><li><a href="Phaser.GameObjects.Text.html">Phaser.GameObjects.Text</a></li><li><a href="Phaser.GameObjects.TextStyle.html">Phaser.GameObjects.TextStyle</a></li><li><a href="Phaser.GameObjects.TileSprite.html">Phaser.GameObjects.TileSprite</a></li><li><a href="Phaser.GameObjects.Triangle.html">Phaser.GameObjects.Triangle</a></li><li><a href="Phaser.GameObjects.UpdateList.html">Phaser.GameObjects.UpdateList</a></li><li><a href="Phaser.GameObjects.Video.html">Phaser.GameObjects.Video</a></li><li><a href="Phaser.GameObjects.Zone.html">Phaser.GameObjects.Zone</a></li><li><a href="Phaser.Geom.Circle.html">Phaser.Geom.Circle</a></li><li><a href="Phaser.Geom.Ellipse.html">Phaser.Geom.Ellipse</a></li><li><a href="Phaser.Geom.Line.html">Phaser.Geom.Line</a></li><li><a href="Phaser.Geom.Point.html">Phaser.Geom.Point</a></li><li><a href="Phaser.Geom.Polygon.html">Phaser.Geom.Polygon</a></li><li><a href="Phaser.Geom.Rectangle.html">Phaser.Geom.Rectangle</a></li><li><a href="Phaser.Geom.Triangle.html">Phaser.Geom.Triangle</a></li><li><a href="Phaser.Input.Gamepad.Axis.html">Phaser.Input.Gamepad.Axis</a></li><li><a href="Phaser.Input.Gamepad.Button.html">Phaser.Input.Gamepad.Button</a></li><li><a href="Phaser.Input.Gamepad.Gamepad.html">Phaser.Input.Gamepad.Gamepad</a></li><li><a href="Phaser.Input.Gamepad.GamepadPlugin.html">Phaser.Input.Gamepad.GamepadPlugin</a></li><li><a href="Phaser.Input.InputManager.html">Phaser.Input.InputManager</a></li><li><a href="Phaser.Input.InputPlugin.html">Phaser.Input.InputPlugin</a></li><li><a href="Phaser.Input.Keyboard.Key.html">Phaser.Input.Keyboard.Key</a></li><li><a href="Phaser.Input.Keyboard.KeyboardManager.html">Phaser.Input.Keyboard.KeyboardManager</a></li><li><a href="Phaser.Input.Keyboard.KeyboardPlugin.html">Phaser.Input.Keyboard.KeyboardPlugin</a></li><li><a href="Phaser.Input.Keyboard.KeyCombo.html">Phaser.Input.Keyboard.KeyCombo</a></li><li><a href="Phaser.Input.Mouse.MouseManager.html">Phaser.Input.Mouse.MouseManager</a></li><li><a href="Phaser.Input.Pointer.html">Phaser.Input.Pointer</a></li><li><a href="Phaser.Input.Touch.TouchManager.html">Phaser.Input.Touch.TouchManager</a></li><li><a href="Phaser.Loader.File.html">Phaser.Loader.File</a></li><li><a href="Phaser.Loader.FileTypes.AnimationJSONFile.html">Phaser.Loader.FileTypes.AnimationJSONFile</a></li><li><a href="Phaser.Loader.FileTypes.AtlasJSONFile.html">Phaser.Loader.FileTypes.AtlasJSONFile</a></li><li><a href="Phaser.Loader.FileTypes.AtlasXMLFile.html">Phaser.Loader.FileTypes.AtlasXMLFile</a></li><li><a href="Phaser.Loader.FileTypes.AudioFile.html">Phaser.Loader.FileTypes.AudioFile</a></li><li><a href="Phaser.Loader.FileTypes.AudioSpriteFile.html">Phaser.Loader.FileTypes.AudioSpriteFile</a></li><li><a href="Phaser.Loader.FileTypes.BinaryFile.html">Phaser.Loader.FileTypes.BinaryFile</a></li><li><a href="Phaser.Loader.FileTypes.BitmapFontFile.html">Phaser.Loader.FileTypes.BitmapFontFile</a></li><li><a href="Phaser.Loader.FileTypes.CSSFile.html">Phaser.Loader.FileTypes.CSSFile</a></li><li><a href="Phaser.Loader.FileTypes.GLSLFile.html">Phaser.Loader.FileTypes.GLSLFile</a></li><li><a href="Phaser.Loader.FileTypes.HTML5AudioFile.html">Phaser.Loader.FileTypes.HTML5AudioFile</a></li><li><a href="Phaser.Loader.FileTypes.HTMLFile.html">Phaser.Loader.FileTypes.HTMLFile</a></li><li><a href="Phaser.Loader.FileTypes.HTMLTextureFile.html">Phaser.Loader.FileTypes.HTMLTextureFile</a></li><li><a href="Phaser.Loader.FileTypes.ImageFile.html">Phaser.Loader.FileTypes.ImageFile</a></li><li><a href="Phaser.Loader.FileTypes.JSONFile.html">Phaser.Loader.FileTypes.JSONFile</a></li><li><a href="Phaser.Loader.FileTypes.MultiAtlasFile.html">Phaser.Loader.FileTypes.MultiAtlasFile</a></li><li><a href="Phaser.Loader.FileTypes.MultiScriptFile.html">Phaser.Loader.FileTypes.MultiScriptFile</a></li><li><a href="Phaser.Loader.FileTypes.PackFile.html">Phaser.Loader.FileTypes.PackFile</a></li><li><a href="Phaser.Loader.FileTypes.PluginFile.html">Phaser.Loader.FileTypes.PluginFile</a></li><li><a href="Phaser.Loader.FileTypes.SceneFile.html">Phaser.Loader.FileTypes.SceneFile</a></li><li><a href="Phaser.Loader.FileTypes.ScenePluginFile.html">Phaser.Loader.FileTypes.ScenePluginFile</a></li><li><a href="Phaser.Loader.FileTypes.ScriptFile.html">Phaser.Loader.FileTypes.ScriptFile</a></li><li><a href="Phaser.Loader.FileTypes.SpineFile.html">Phaser.Loader.FileTypes.SpineFile</a></li><li><a href="Phaser.Loader.FileTypes.SpriteSheetFile.html">Phaser.Loader.FileTypes.SpriteSheetFile</a></li><li><a href="Phaser.Loader.FileTypes.SVGFile.html">Phaser.Loader.FileTypes.SVGFile</a></li><li><a href="Phaser.Loader.FileTypes.TextFile.html">Phaser.Loader.FileTypes.TextFile</a></li><li><a href="Phaser.Loader.FileTypes.TilemapCSVFile.html">Phaser.Loader.FileTypes.TilemapCSVFile</a></li><li><a href="Phaser.Loader.FileTypes.TilemapImpactFile.html">Phaser.Loader.FileTypes.TilemapImpactFile</a></li><li><a href="Phaser.Loader.FileTypes.TilemapJSONFile.html">Phaser.Loader.FileTypes.TilemapJSONFile</a></li><li><a href="Phaser.Loader.FileTypes.UnityAtlasFile.html">Phaser.Loader.FileTypes.UnityAtlasFile</a></li><li><a href="Phaser.Loader.FileTypes.VideoFile.html">Phaser.Loader.FileTypes.VideoFile</a></li><li><a href="Phaser.Loader.FileTypes.XMLFile.html">Phaser.Loader.FileTypes.XMLFile</a></li><li><a href="Phaser.Loader.LoaderPlugin.html">Phaser.Loader.LoaderPlugin</a></li><li><a href="Phaser.Loader.MultiFile.html">Phaser.Loader.MultiFile</a></li><li><a href="Phaser.Math.Matrix3.html">Phaser.Math.Matrix3</a></li><li><a href="Phaser.Math.Matrix4.html">Phaser.Math.Matrix4</a></li><li><a href="Phaser.Math.Quaternion.html">Phaser.Math.Quaternion</a></li><li><a href="Phaser.Math.RandomDataGenerator.html">Phaser.Math.RandomDataGenerator</a></li><li><a href="Phaser.Math.Vector2.html">Phaser.Math.Vector2</a></li><li><a href="Phaser.Math.Vector3.html">Phaser.Math.Vector3</a></li><li><a href="Phaser.Math.Vector4.html">Phaser.Math.Vector4</a></li><li><a href="Phaser.Physics.Arcade.ArcadePhysics.html">Phaser.Physics.Arcade.ArcadePhysics</a></li><li><a href="Phaser.Physics.Arcade.Body.html">Phaser.Physics.Arcade.Body</a></li><li><a href="Phaser.Physics.Arcade.Collider.html">Phaser.Physics.Arcade.Collider</a></li><li><a href="Phaser.Physics.Arcade.Factory.html">Phaser.Physics.Arcade.Factory</a></li><li><a href="Phaser.Physics.Arcade.Group.html">Phaser.Physics.Arcade.Group</a></li><li><a href="Phaser.Physics.Arcade.Image.html">Phaser.Physics.Arcade.Image</a></li><li><a href="Phaser.Physics.Arcade.Sprite.html">Phaser.Physics.Arcade.Sprite</a></li><li><a href="Phaser.Physics.Arcade.StaticBody.html">Phaser.Physics.Arcade.StaticBody</a></li><li><a href="Phaser.Physics.Arcade.StaticGroup.html">Phaser.Physics.Arcade.StaticGroup</a></li><li><a href="Phaser.Physics.Arcade.World.html">Phaser.Physics.Arcade.World</a></li><li><a href="Phaser.Physics.Matter.BodyBounds.html">Phaser.Physics.Matter.BodyBounds</a></li><li><a href="Phaser.Physics.Matter.Factory.html">Phaser.Physics.Matter.Factory</a></li><li><a href="Phaser.Physics.Matter.Image.html">Phaser.Physics.Matter.Image</a></li><li><a href="Phaser.Physics.Matter.MatterPhysics.html">Phaser.Physics.Matter.MatterPhysics</a></li><li><a href="Phaser.Physics.Matter.PointerConstraint.html">Phaser.Physics.Matter.PointerConstraint</a></li><li><a href="Phaser.Physics.Matter.Sprite.html">Phaser.Physics.Matter.Sprite</a></li><li><a href="Phaser.Physics.Matter.TileBody.html">Phaser.Physics.Matter.TileBody</a></li><li><a href="Phaser.Physics.Matter.World.html">Phaser.Physics.Matter.World</a></li><li><a href="Phaser.Plugins.BasePlugin.html">Phaser.Plugins.BasePlugin</a></li><li><a href="Phaser.Plugins.PluginManager.html">Phaser.Plugins.PluginManager</a></li><li><a href="Phaser.Plugins.ScenePlugin.html">Phaser.Plugins.ScenePlugin</a></li><li><a href="Phaser.Renderer.Canvas.CanvasRenderer.html">Phaser.Renderer.Canvas.CanvasRenderer</a></li><li><a href="Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline.html">Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline</a></li><li><a href="Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline.html">Phaser.Renderer.WebGL.Pipelines.ForwardDiffuseLightPipeline</a></li><li><a href="Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline.html">Phaser.Renderer.WebGL.Pipelines.TextureTintPipeline</a></li><li><a href="Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline.html">Phaser.Renderer.WebGL.Pipelines.TextureTintStripPipeline</a></li><li><a href="Phaser.Renderer.WebGL.WebGLPipeline.html">Phaser.Renderer.WebGL.WebGLPipeline</a></li><li><a href="Phaser.Renderer.WebGL.WebGLRenderer.html">Phaser.Renderer.WebGL.WebGLRenderer</a></li><li><a href="Phaser.Scale.ScaleManager.html">Phaser.Scale.ScaleManager</a></li><li><a href="Phaser.Scene.html">Phaser.Scene</a></li><li><a href="Phaser.Scenes.SceneManager.html">Phaser.Scenes.SceneManager</a></li><li><a href="Phaser.Scenes.ScenePlugin.html">Phaser.Scenes.ScenePlugin</a></li><li><a href="Phaser.Scenes.Systems.html">Phaser.Scenes.Systems</a></li><li><a href="Phaser.Sound.BaseSound.html">Phaser.Sound.BaseSound</a></li><li><a href="Phaser.Sound.BaseSoundManager.html">Phaser.Sound.BaseSoundManager</a></li><li><a href="Phaser.Sound.HTML5AudioSound.html">Phaser.Sound.HTML5AudioSound</a></li><li><a href="Phaser.Sound.HTML5AudioSoundManager.html">Phaser.Sound.HTML5AudioSoundManager</a></li><li><a href="Phaser.Sound.NoAudioSound.html">Phaser.Sound.NoAudioSound</a></li><li><a href="Phaser.Sound.NoAudioSoundManager.html">Phaser.Sound.NoAudioSoundManager</a></li><li><a href="Phaser.Sound.WebAudioSound.html">Phaser.Sound.WebAudioSound</a></li><li><a href="Phaser.Sound.WebAudioSoundManager.html">Phaser.Sound.WebAudioSoundManager</a></li><li><a href="Phaser.Structs.List.html">Phaser.Structs.List</a></li><li><a href="Phaser.Structs.Map.html">Phaser.Structs.Map</a></li><li><a href="Phaser.Structs.ProcessQueue.html">Phaser.Structs.ProcessQueue</a></li><li><a href="Phaser.Structs.RTree.html">Phaser.Structs.RTree</a></li><li><a href="Phaser.Structs.Set.html">Phaser.Structs.Set</a></li><li><a href="Phaser.Structs.Size.html">Phaser.Structs.Size</a></li><li><a href="Phaser.Textures.CanvasTexture.html">Phaser.Textures.CanvasTexture</a></li><li><a href="Phaser.Textures.Frame.html">Phaser.Textures.Frame</a></li><li><a href="Phaser.Textures.Texture.html">Phaser.Textures.Texture</a></li><li><a href="Phaser.Textures.TextureManager.html">Phaser.Textures.TextureManager</a></li><li><a href="Phaser.Textures.TextureSource.html">Phaser.Textures.TextureSource</a></li><li><a href="Phaser.Tilemaps.DynamicTilemapLayer.html">Phaser.Tilemaps.DynamicTilemapLayer</a></li><li><a href="Phaser.Tilemaps.ImageCollection.html">Phaser.Tilemaps.ImageCollection</a></li><li><a href="Phaser.Tilemaps.LayerData.html">Phaser.Tilemaps.LayerData</a></li><li><a href="Phaser.Tilemaps.MapData.html">Phaser.Tilemaps.MapData</a></li><li><a href="Phaser.Tilemaps.ObjectLayer.html">Phaser.Tilemaps.ObjectLayer</a></li><li><a href="Phaser.Tilemaps.StaticTilemapLayer.html">Phaser.Tilemaps.StaticTilemapLayer</a></li><li><a href="Phaser.Tilemaps.Tile.html">Phaser.Tilemaps.Tile</a></li><li><a href="Phaser.Tilemaps.Tilemap.html">Phaser.Tilemaps.Tilemap</a></li><li><a href="Phaser.Tilemaps.Tileset.html">Phaser.Tilemaps.Tileset</a></li><li><a href="Phaser.Time.Clock.html">Phaser.Time.Clock</a></li><li><a href="Phaser.Time.TimerEvent.html">Phaser.Time.TimerEvent</a></li><li><a href="Phaser.Tweens.Timeline.html">Phaser.Tweens.Timeline</a></li><li><a href="Phaser.Tweens.Tween.html">Phaser.Tweens.Tween</a></li><li><a href="Phaser.Tweens.TweenManager.html">Phaser.Tweens.TweenManager</a></li><li><a href="SpineGameObject.html">SpineGameObject</a></li><li><a href="SpinePlugin.html">SpinePlugin</a></li>
				</ul>
			</li>
			
			<li class="dropdown">
				<a href="events.list.html" class="dropdown-toggle" data-toggle="dropdown">Events<b class="caret"></b></a>
				<ul class="dropdown-menu ">
					<li><a href="Phaser.Animations.Events.html#event:ADD_ANIMATION">Phaser.Animations.Events#event:ADD_ANIMATION</a></li><li><a href="Phaser.Animations.Events.html#event:ANIMATION_COMPLETE">Phaser.Animations.Events#event:ANIMATION_COMPLETE</a></li><li><a href="Phaser.Animations.Events.html#event:ANIMATION_REPEAT">Phaser.Animations.Events#event:ANIMATION_REPEAT</a></li><li><a href="Phaser.Animations.Events.html#event:ANIMATION_RESTART">Phaser.Animations.Events#event:ANIMATION_RESTART</a></li><li><a href="Phaser.Animations.Events.html#event:ANIMATION_START">Phaser.Animations.Events#event:ANIMATION_START</a></li><li><a href="Phaser.Animations.Events.html#event:PAUSE_ALL">Phaser.Animations.Events#event:PAUSE_ALL</a></li><li><a href="Phaser.Animations.Events.html#event:REMOVE_ANIMATION">Phaser.Animations.Events#event:REMOVE_ANIMATION</a></li><li><a href="Phaser.Animations.Events.html#event:RESUME_ALL">Phaser.Animations.Events#event:RESUME_ALL</a></li><li><a href="Phaser.Animations.Events.html#event:SPRITE_ANIMATION_COMPLETE">Phaser.Animations.Events#event:SPRITE_ANIMATION_COMPLETE</a></li><li><a href="Phaser.Animations.Events.html#event:SPRITE_ANIMATION_KEY_COMPLETE">Phaser.Animations.Events#event:SPRITE_ANIMATION_KEY_COMPLETE</a></li><li><a href="Phaser.Animations.Events.html#event:SPRITE_ANIMATION_KEY_REPEAT">Phaser.Animations.Events#event:SPRITE_ANIMATION_KEY_REPEAT</a></li><li><a href="Phaser.Animations.Events.html#event:SPRITE_ANIMATION_KEY_RESTART">Phaser.Animations.Events#event:SPRITE_ANIMATION_KEY_RESTART</a></li><li><a href="Phaser.Animations.Events.html#event:SPRITE_ANIMATION_KEY_START">Phaser.Animations.Events#event:SPRITE_ANIMATION_KEY_START</a></li><li><a href="Phaser.Animations.Events.html#event:SPRITE_ANIMATION_KEY_UPDATE">Phaser.Animations.Events#event:SPRITE_ANIMATION_KEY_UPDATE</a></li><li><a href="Phaser.Animations.Events.html#event:SPRITE_ANIMATION_REPEAT">Phaser.Animations.Events#event:SPRITE_ANIMATION_REPEAT</a></li><li><a href="Phaser.Animations.Events.html#event:SPRITE_ANIMATION_RESTART">Phaser.Animations.Events#event:SPRITE_ANIMATION_RESTART</a></li><li><a href="Phaser.Animations.Events.html#event:SPRITE_ANIMATION_START">Phaser.Animations.Events#event:SPRITE_ANIMATION_START</a></li><li><a href="Phaser.Animations.Events.html#event:SPRITE_ANIMATION_UPDATE">Phaser.Animations.Events#event:SPRITE_ANIMATION_UPDATE</a></li><li><a href="Phaser.Cache.Events.html#event:ADD">Phaser.Cache.Events#event:ADD</a></li><li><a href="Phaser.Cache.Events.html#event:REMOVE">Phaser.Cache.Events#event:REMOVE</a></li><li><a href="Phaser.Cameras.Scene2D.Events.html#event:DESTROY">Phaser.Cameras.Scene2D.Events#event:DESTROY</a></li><li><a href="Phaser.Cameras.Scene2D.Events.html#event:FADE_IN_COMPLETE">Phaser.Cameras.Scene2D.Events#event:FADE_IN_COMPLETE</a></li><li><a href="Phaser.Cameras.Scene2D.Events.html#event:FADE_IN_START">Phaser.Cameras.Scene2D.Events#event:FADE_IN_START</a></li><li><a href="Phaser.Cameras.Scene2D.Events.html#event:FADE_OUT_COMPLETE">Phaser.Cameras.Scene2D.Events#event:FADE_OUT_COMPLETE</a></li><li><a href="Phaser.Cameras.Scene2D.Events.html#event:FADE_OUT_START">Phaser.Cameras.Scene2D.Events#event:FADE_OUT_START</a></li><li><a href="Phaser.Cameras.Scene2D.Events.html#event:FLASH_COMPLETE">Phaser.Cameras.Scene2D.Events#event:FLASH_COMPLETE</a></li><li><a href="Phaser.Cameras.Scene2D.Events.html#event:FLASH_START">Phaser.Cameras.Scene2D.Events#event:FLASH_START</a></li><li><a href="Phaser.Cameras.Scene2D.Events.html#event:PAN_COMPLETE">Phaser.Cameras.Scene2D.Events#event:PAN_COMPLETE</a></li><li><a href="Phaser.Cameras.Scene2D.Events.html#event:PAN_START">Phaser.Cameras.Scene2D.Events#event:PAN_START</a></li><li><a href="Phaser.Cameras.Scene2D.Events.html#event:POST_RENDER">Phaser.Cameras.Scene2D.Events#event:POST_RENDER</a></li><li><a href="Phaser.Cameras.Scene2D.Events.html#event:PRE_RENDER">Phaser.Cameras.Scene2D.Events#event:PRE_RENDER</a></li><li><a href="Phaser.Cameras.Scene2D.Events.html#event:ROTATE_COMPLETE">Phaser.Cameras.Scene2D.Events#event:ROTATE_COMPLETE</a></li><li><a href="Phaser.Cameras.Scene2D.Events.html#event:ROTATE_START">Phaser.Cameras.Scene2D.Events#event:ROTATE_START</a></li><li><a href="Phaser.Cameras.Scene2D.Events.html#event:SHAKE_COMPLETE">Phaser.Cameras.Scene2D.Events#event:SHAKE_COMPLETE</a></li><li><a href="Phaser.Cameras.Scene2D.Events.html#event:SHAKE_START">Phaser.Cameras.Scene2D.Events#event:SHAKE_START</a></li><li><a href="Phaser.Cameras.Scene2D.Events.html#event:ZOOM_COMPLETE">Phaser.Cameras.Scene2D.Events#event:ZOOM_COMPLETE</a></li><li><a href="Phaser.Cameras.Scene2D.Events.html#event:ZOOM_START">Phaser.Cameras.Scene2D.Events#event:ZOOM_START</a></li><li><a href="Phaser.Core.Events.html#event:BLUR">Phaser.Core.Events#event:BLUR</a></li><li><a href="Phaser.Core.Events.html#event:BOOT">Phaser.Core.Events#event:BOOT</a></li><li><a href="Phaser.Core.Events.html#event:CONTEXT_LOST">Phaser.Core.Events#event:CONTEXT_LOST</a></li><li><a href="Phaser.Core.Events.html#event:CONTEXT_RESTORED">Phaser.Core.Events#event:CONTEXT_RESTORED</a></li><li><a href="Phaser.Core.Events.html#event:DESTROY">Phaser.Core.Events#event:DESTROY</a></li><li><a href="Phaser.Core.Events.html#event:FOCUS">Phaser.Core.Events#event:FOCUS</a></li><li><a href="Phaser.Core.Events.html#event:HIDDEN">Phaser.Core.Events#event:HIDDEN</a></li><li><a href="Phaser.Core.Events.html#event:PAUSE">Phaser.Core.Events#event:PAUSE</a></li><li><a href="Phaser.Core.Events.html#event:POST_RENDER">Phaser.Core.Events#event:POST_RENDER</a></li><li><a href="Phaser.Core.Events.html#event:POST_STEP">Phaser.Core.Events#event:POST_STEP</a></li><li><a href="Phaser.Core.Events.html#event:PRE_RENDER">Phaser.Core.Events#event:PRE_RENDER</a></li><li><a href="Phaser.Core.Events.html#event:PRE_STEP">Phaser.Core.Events#event:PRE_STEP</a></li><li><a href="Phaser.Core.Events.html#event:READY">Phaser.Core.Events#event:READY</a></li><li><a href="Phaser.Core.Events.html#event:RESUME">Phaser.Core.Events#event:RESUME</a></li><li><a href="Phaser.Core.Events.html#event:STEP">Phaser.Core.Events#event:STEP</a></li><li><a href="Phaser.Core.Events.html#event:VISIBLE">Phaser.Core.Events#event:VISIBLE</a></li><li><a href="Phaser.Data.Events.html#event:CHANGE_DATA">Phaser.Data.Events#event:CHANGE_DATA</a></li><li><a href="Phaser.Data.Events.html#event:CHANGE_DATA_KEY">Phaser.Data.Events#event:CHANGE_DATA_KEY</a></li><li><a href="Phaser.Data.Events.html#event:REMOVE_DATA">Phaser.Data.Events#event:REMOVE_DATA</a></li><li><a href="Phaser.Data.Events.html#event:SET_DATA">Phaser.Data.Events#event:SET_DATA</a></li><li><a href="Phaser.GameObjects.Events.html#event:DESTROY">Phaser.GameObjects.Events#event:DESTROY</a></li><li><a href="Phaser.GameObjects.Events.html#event:VIDEO_COMPLETE">Phaser.GameObjects.Events#event:VIDEO_COMPLETE</a></li><li><a href="Phaser.GameObjects.Events.html#event:VIDEO_CREATED">Phaser.GameObjects.Events#event:VIDEO_CREATED</a></li><li><a href="Phaser.GameObjects.Events.html#event:VIDEO_ERROR">Phaser.GameObjects.Events#event:VIDEO_ERROR</a></li><li><a href="Phaser.GameObjects.Events.html#event:VIDEO_LOOP">Phaser.GameObjects.Events#event:VIDEO_LOOP</a></li><li><a href="Phaser.GameObjects.Events.html#event:VIDEO_PLAY">Phaser.GameObjects.Events#event:VIDEO_PLAY</a></li><li><a href="Phaser.GameObjects.Events.html#event:VIDEO_SEEKED">Phaser.GameObjects.Events#event:VIDEO_SEEKED</a></li><li><a href="Phaser.GameObjects.Events.html#event:VIDEO_SEEKING">Phaser.GameObjects.Events#event:VIDEO_SEEKING</a></li><li><a href="Phaser.GameObjects.Events.html#event:VIDEO_STOP">Phaser.GameObjects.Events#event:VIDEO_STOP</a></li><li><a href="Phaser.GameObjects.Events.html#event:VIDEO_TIMEOUT">Phaser.GameObjects.Events#event:VIDEO_TIMEOUT</a></li><li><a href="Phaser.GameObjects.Events.html#event:VIDEO_UNLOCKED">Phaser.GameObjects.Events#event:VIDEO_UNLOCKED</a></li><li><a href="Phaser.Input.Events.html#event:BOOT">Phaser.Input.Events#event:BOOT</a></li><li><a href="Phaser.Input.Events.html#event:DESTROY">Phaser.Input.Events#event:DESTROY</a></li><li><a href="Phaser.Input.Events.html#event:DRAG">Phaser.Input.Events#event:DRAG</a></li><li><a href="Phaser.Input.Events.html#event:DRAG_END">Phaser.Input.Events#event:DRAG_END</a></li><li><a href="Phaser.Input.Events.html#event:DRAG_ENTER">Phaser.Input.Events#event:DRAG_ENTER</a></li><li><a href="Phaser.Input.Events.html#event:DRAG_LEAVE">Phaser.Input.Events#event:DRAG_LEAVE</a></li><li><a href="Phaser.Input.Events.html#event:DRAG_OVER">Phaser.Input.Events#event:DRAG_OVER</a></li><li><a href="Phaser.Input.Events.html#event:DRAG_START">Phaser.Input.Events#event:DRAG_START</a></li><li><a href="Phaser.Input.Events.html#event:DROP">Phaser.Input.Events#event:DROP</a></li><li><a href="Phaser.Input.Events.html#event:GAME_OUT">Phaser.Input.Events#event:GAME_OUT</a></li><li><a href="Phaser.Input.Events.html#event:GAME_OVER">Phaser.Input.Events#event:GAME_OVER</a></li><li><a href="Phaser.Input.Events.html#event:GAMEOBJECT_DOWN">Phaser.Input.Events#event:GAMEOBJECT_DOWN</a></li><li><a href="Phaser.Input.Events.html#event:GAMEOBJECT_DRAG">Phaser.Input.Events#event:GAMEOBJECT_DRAG</a></li><li><a href="Phaser.Input.Events.html#event:GAMEOBJECT_DRAG_END">Phaser.Input.Events#event:GAMEOBJECT_DRAG_END</a></li><li><a href="Phaser.Input.Events.html#event:GAMEOBJECT_DRAG_ENTER">Phaser.Input.Events#event:GAMEOBJECT_DRAG_ENTER</a></li><li><a href="Phaser.Input.Events.html#event:GAMEOBJECT_DRAG_LEAVE">Phaser.Input.Events#event:GAMEOBJECT_DRAG_LEAVE</a></li><li><a href="Phaser.Input.Events.html#event:GAMEOBJECT_DRAG_OVER">Phaser.Input.Events#event:GAMEOBJECT_DRAG_OVER</a></li><li><a href="Phaser.Input.Events.html#event:GAMEOBJECT_DRAG_START">Phaser.Input.Events#event:GAMEOBJECT_DRAG_START</a></li><li><a href="Phaser.Input.Events.html#event:GAMEOBJECT_DROP">Phaser.Input.Events#event:GAMEOBJECT_DROP</a></li><li><a href="Phaser.Input.Events.html#event:GAMEOBJECT_MOVE">Phaser.Input.Events#event:GAMEOBJECT_MOVE</a></li><li><a href="Phaser.Input.Events.html#event:GAMEOBJECT_OUT">Phaser.Input.Events#event:GAMEOBJECT_OUT</a></li><li><a href="Phaser.Input.Events.html#event:GAMEOBJECT_OVER">Phaser.Input.Events#event:GAMEOBJECT_OVER</a></li><li><a href="Phaser.Input.Events.html#event:GAMEOBJECT_POINTER_DOWN">Phaser.Input.Events#event:GAMEOBJECT_POINTER_DOWN</a></li><li><a href="Phaser.Input.Events.html#event:GAMEOBJECT_POINTER_MOVE">Phaser.Input.Events#event:GAMEOBJECT_POINTER_MOVE</a></li><li><a href="Phaser.Input.Events.html#event:GAMEOBJECT_POINTER_OUT">Phaser.Input.Events#event:GAMEOBJECT_POINTER_OUT</a></li><li><a href="Phaser.Input.Events.html#event:GAMEOBJECT_POINTER_OVER">Phaser.Input.Events#event:GAMEOBJECT_POINTER_OVER</a></li><li><a href="Phaser.Input.Events.html#event:GAMEOBJECT_POINTER_UP">Phaser.Input.Events#event:GAMEOBJECT_POINTER_UP</a></li><li><a href="Phaser.Input.Events.html#event:GAMEOBJECT_POINTER_WHEEL">Phaser.Input.Events#event:GAMEOBJECT_POINTER_WHEEL</a></li><li><a href="Phaser.Input.Events.html#event:GAMEOBJECT_UP">Phaser.Input.Events#event:GAMEOBJECT_UP</a></li><li><a href="Phaser.Input.Events.html#event:GAMEOBJECT_WHEEL">Phaser.Input.Events#event:GAMEOBJECT_WHEEL</a></li><li><a href="Phaser.Input.Events.html#event:MANAGER_BOOT">Phaser.Input.Events#event:MANAGER_BOOT</a></li><li><a href="Phaser.Input.Events.html#event:MANAGER_PROCESS">Phaser.Input.Events#event:MANAGER_PROCESS</a></li><li><a href="Phaser.Input.Events.html#event:MANAGER_UPDATE">Phaser.Input.Events#event:MANAGER_UPDATE</a></li><li><a href="Phaser.Input.Events.html#event:POINTER_DOWN">Phaser.Input.Events#event:POINTER_DOWN</a></li><li><a href="Phaser.Input.Events.html#event:POINTER_DOWN_OUTSIDE">Phaser.Input.Events#event:POINTER_DOWN_OUTSIDE</a></li><li><a href="Phaser.Input.Events.html#event:POINTER_MOVE">Phaser.Input.Events#event:POINTER_MOVE</a></li><li><a href="Phaser.Input.Events.html#event:POINTER_OUT">Phaser.Input.Events#event:POINTER_OUT</a></li><li><a href="Phaser.Input.Events.html#event:POINTER_OVER">Phaser.Input.Events#event:POINTER_OVER</a></li><li><a href="Phaser.Input.Events.html#event:POINTER_UP">Phaser.Input.Events#event:POINTER_UP</a></li><li><a href="Phaser.Input.Events.html#event:POINTER_UP_OUTSIDE">Phaser.Input.Events#event:POINTER_UP_OUTSIDE</a></li><li><a href="Phaser.Input.Events.html#event:POINTER_WHEEL">Phaser.Input.Events#event:POINTER_WHEEL</a></li><li><a href="Phaser.Input.Events.html#event:POINTERLOCK_CHANGE">Phaser.Input.Events#event:POINTERLOCK_CHANGE</a></li><li><a href="Phaser.Input.Events.html#event:PRE_UPDATE">Phaser.Input.Events#event:PRE_UPDATE</a></li><li><a href="Phaser.Input.Events.html#event:SHUTDOWN">Phaser.Input.Events#event:SHUTDOWN</a></li><li><a href="Phaser.Input.Events.html#event:START">Phaser.Input.Events#event:START</a></li><li><a href="Phaser.Input.Events.html#event:UPDATE">Phaser.Input.Events#event:UPDATE</a></li><li><a href="Phaser.Input.Gamepad.Events.html#event:BUTTON_DOWN">Phaser.Input.Gamepad.Events#event:BUTTON_DOWN</a></li><li><a href="Phaser.Input.Gamepad.Events.html#event:BUTTON_UP">Phaser.Input.Gamepad.Events#event:BUTTON_UP</a></li><li><a href="Phaser.Input.Gamepad.Events.html#event:CONNECTED">Phaser.Input.Gamepad.Events#event:CONNECTED</a></li><li><a href="Phaser.Input.Gamepad.Events.html#event:DISCONNECTED">Phaser.Input.Gamepad.Events#event:DISCONNECTED</a></li><li><a href="Phaser.Input.Gamepad.Events.html#event:GAMEPAD_BUTTON_DOWN">Phaser.Input.Gamepad.Events#event:GAMEPAD_BUTTON_DOWN</a></li><li><a href="Phaser.Input.Gamepad.Events.html#event:GAMEPAD_BUTTON_UP">Phaser.Input.Gamepad.Events#event:GAMEPAD_BUTTON_UP</a></li><li><a href="Phaser.Input.Keyboard.Events.html#event:ANY_KEY_DOWN">Phaser.Input.Keyboard.Events#event:ANY_KEY_DOWN</a></li><li><a href="Phaser.Input.Keyboard.Events.html#event:ANY_KEY_UP">Phaser.Input.Keyboard.Events#event:ANY_KEY_UP</a></li><li><a href="Phaser.Input.Keyboard.Events.html#event:COMBO_MATCH">Phaser.Input.Keyboard.Events#event:COMBO_MATCH</a></li><li><a href="Phaser.Input.Keyboard.Events.html#event:DOWN">Phaser.Input.Keyboard.Events#event:DOWN</a></li><li><a href="Phaser.Input.Keyboard.Events.html#event:KEY_DOWN">Phaser.Input.Keyboard.Events#event:KEY_DOWN</a></li><li><a href="Phaser.Input.Keyboard.Events.html#event:KEY_UP">Phaser.Input.Keyboard.Events#event:KEY_UP</a></li><li><a href="Phaser.Input.Keyboard.Events.html#event:UP">Phaser.Input.Keyboard.Events#event:UP</a></li><li><a href="Phaser.Loader.Events.html#event:ADD">Phaser.Loader.Events#event:ADD</a></li><li><a href="Phaser.Loader.Events.html#event:COMPLETE">Phaser.Loader.Events#event:COMPLETE</a></li><li><a href="Phaser.Loader.Events.html#event:FILE_COMPLETE">Phaser.Loader.Events#event:FILE_COMPLETE</a></li><li><a href="Phaser.Loader.Events.html#event:FILE_KEY_COMPLETE">Phaser.Loader.Events#event:FILE_KEY_COMPLETE</a></li><li><a href="Phaser.Loader.Events.html#event:FILE_LOAD">Phaser.Loader.Events#event:FILE_LOAD</a></li><li><a href="Phaser.Loader.Events.html#event:FILE_LOAD_ERROR">Phaser.Loader.Events#event:FILE_LOAD_ERROR</a></li><li><a href="Phaser.Loader.Events.html#event:FILE_PROGRESS">Phaser.Loader.Events#event:FILE_PROGRESS</a></li><li><a href="Phaser.Loader.Events.html#event:POST_PROCESS">Phaser.Loader.Events#event:POST_PROCESS</a></li><li><a href="Phaser.Loader.Events.html#event:PROGRESS">Phaser.Loader.Events#event:PROGRESS</a></li><li><a href="Phaser.Loader.Events.html#event:START">Phaser.Loader.Events#event:START</a></li><li><a href="Phaser.Physics.Arcade.Events.html#event:COLLIDE">Phaser.Physics.Arcade.Events#event:COLLIDE</a></li><li><a href="Phaser.Physics.Arcade.Events.html#event:OVERLAP">Phaser.Physics.Arcade.Events#event:OVERLAP</a></li><li><a href="Phaser.Physics.Arcade.Events.html#event:PAUSE">Phaser.Physics.Arcade.Events#event:PAUSE</a></li><li><a href="Phaser.Physics.Arcade.Events.html#event:RESUME">Phaser.Physics.Arcade.Events#event:RESUME</a></li><li><a href="Phaser.Physics.Arcade.Events.html#event:TILE_COLLIDE">Phaser.Physics.Arcade.Events#event:TILE_COLLIDE</a></li><li><a href="Phaser.Physics.Arcade.Events.html#event:TILE_OVERLAP">Phaser.Physics.Arcade.Events#event:TILE_OVERLAP</a></li><li><a href="Phaser.Physics.Arcade.Events.html#event:WORLD_BOUNDS">Phaser.Physics.Arcade.Events#event:WORLD_BOUNDS</a></li><li><a href="Phaser.Physics.Arcade.Events.html#event:WORLD_STEP">Phaser.Physics.Arcade.Events#event:WORLD_STEP</a></li><li><a href="Phaser.Physics.Matter.Events.html#event:AFTER_ADD">Phaser.Physics.Matter.Events#event:AFTER_ADD</a></li><li><a href="Phaser.Physics.Matter.Events.html#event:AFTER_REMOVE">Phaser.Physics.Matter.Events#event:AFTER_REMOVE</a></li><li><a href="Phaser.Physics.Matter.Events.html#event:AFTER_UPDATE">Phaser.Physics.Matter.Events#event:AFTER_UPDATE</a></li><li><a href="Phaser.Physics.Matter.Events.html#event:BEFORE_ADD">Phaser.Physics.Matter.Events#event:BEFORE_ADD</a></li><li><a href="Phaser.Physics.Matter.Events.html#event:BEFORE_REMOVE">Phaser.Physics.Matter.Events#event:BEFORE_REMOVE</a></li><li><a href="Phaser.Physics.Matter.Events.html#event:BEFORE_UPDATE">Phaser.Physics.Matter.Events#event:BEFORE_UPDATE</a></li><li><a href="Phaser.Physics.Matter.Events.html#event:COLLISION_ACTIVE">Phaser.Physics.Matter.Events#event:COLLISION_ACTIVE</a></li><li><a href="Phaser.Physics.Matter.Events.html#event:COLLISION_END">Phaser.Physics.Matter.Events#event:COLLISION_END</a></li><li><a href="Phaser.Physics.Matter.Events.html#event:COLLISION_START">Phaser.Physics.Matter.Events#event:COLLISION_START</a></li><li><a href="Phaser.Physics.Matter.Events.html#event:DRAG">Phaser.Physics.Matter.Events#event:DRAG</a></li><li><a href="Phaser.Physics.Matter.Events.html#event:DRAG_END">Phaser.Physics.Matter.Events#event:DRAG_END</a></li><li><a href="Phaser.Physics.Matter.Events.html#event:DRAG_START">Phaser.Physics.Matter.Events#event:DRAG_START</a></li><li><a href="Phaser.Physics.Matter.Events.html#event:PAUSE">Phaser.Physics.Matter.Events#event:PAUSE</a></li><li><a href="Phaser.Physics.Matter.Events.html#event:RESUME">Phaser.Physics.Matter.Events#event:RESUME</a></li><li><a href="Phaser.Physics.Matter.Events.html#event:SLEEP_END">Phaser.Physics.Matter.Events#event:SLEEP_END</a></li><li><a href="Phaser.Physics.Matter.Events.html#event:SLEEP_START">Phaser.Physics.Matter.Events#event:SLEEP_START</a></li><li><a href="Phaser.Scale.Events.html#event:ENTER_FULLSCREEN">Phaser.Scale.Events#event:ENTER_FULLSCREEN</a></li><li><a href="Phaser.Scale.Events.html#event:FULLSCREEN_FAILED">Phaser.Scale.Events#event:FULLSCREEN_FAILED</a></li><li><a href="Phaser.Scale.Events.html#event:FULLSCREEN_UNSUPPORTED">Phaser.Scale.Events#event:FULLSCREEN_UNSUPPORTED</a></li><li><a href="Phaser.Scale.Events.html#event:LEAVE_FULLSCREEN">Phaser.Scale.Events#event:LEAVE_FULLSCREEN</a></li><li><a href="Phaser.Scale.Events.html#event:ORIENTATION_CHANGE">Phaser.Scale.Events#event:ORIENTATION_CHANGE</a></li><li><a href="Phaser.Scale.Events.html#event:RESIZE">Phaser.Scale.Events#event:RESIZE</a></li><li><a href="Phaser.Scenes.Events.html#event:BOOT">Phaser.Scenes.Events#event:BOOT</a></li><li><a href="Phaser.Scenes.Events.html#event:CREATE">Phaser.Scenes.Events#event:CREATE</a></li><li><a href="Phaser.Scenes.Events.html#event:DESTROY">Phaser.Scenes.Events#event:DESTROY</a></li><li><a href="Phaser.Scenes.Events.html#event:PAUSE">Phaser.Scenes.Events#event:PAUSE</a></li><li><a href="Phaser.Scenes.Events.html#event:POST_UPDATE">Phaser.Scenes.Events#event:POST_UPDATE</a></li><li><a href="Phaser.Scenes.Events.html#event:PRE_UPDATE">Phaser.Scenes.Events#event:PRE_UPDATE</a></li><li><a href="Phaser.Scenes.Events.html#event:READY">Phaser.Scenes.Events#event:READY</a></li><li><a href="Phaser.Scenes.Events.html#event:RENDER">Phaser.Scenes.Events#event:RENDER</a></li><li><a href="Phaser.Scenes.Events.html#event:RESUME">Phaser.Scenes.Events#event:RESUME</a></li><li><a href="Phaser.Scenes.Events.html#event:SHUTDOWN">Phaser.Scenes.Events#event:SHUTDOWN</a></li><li><a href="Phaser.Scenes.Events.html#event:SLEEP">Phaser.Scenes.Events#event:SLEEP</a></li><li><a href="Phaser.Scenes.Events.html#event:START">Phaser.Scenes.Events#event:START</a></li><li><a href="Phaser.Scenes.Events.html#event:TRANSITION_COMPLETE">Phaser.Scenes.Events#event:TRANSITION_COMPLETE</a></li><li><a href="Phaser.Scenes.Events.html#event:TRANSITION_INIT">Phaser.Scenes.Events#event:TRANSITION_INIT</a></li><li><a href="Phaser.Scenes.Events.html#event:TRANSITION_OUT">Phaser.Scenes.Events#event:TRANSITION_OUT</a></li><li><a href="Phaser.Scenes.Events.html#event:TRANSITION_START">Phaser.Scenes.Events#event:TRANSITION_START</a></li><li><a href="Phaser.Scenes.Events.html#event:TRANSITION_WAKE">Phaser.Scenes.Events#event:TRANSITION_WAKE</a></li><li><a href="Phaser.Scenes.Events.html#event:UPDATE">Phaser.Scenes.Events#event:UPDATE</a></li><li><a href="Phaser.Scenes.Events.html#event:WAKE">Phaser.Scenes.Events#event:WAKE</a></li><li><a href="Phaser.Sound.Events.html#event:COMPLETE">Phaser.Sound.Events#event:COMPLETE</a></li><li><a href="Phaser.Sound.Events.html#event:DECODED">Phaser.Sound.Events#event:DECODED</a></li><li><a href="Phaser.Sound.Events.html#event:DECODED_ALL">Phaser.Sound.Events#event:DECODED_ALL</a></li><li><a href="Phaser.Sound.Events.html#event:DESTROY">Phaser.Sound.Events#event:DESTROY</a></li><li><a href="Phaser.Sound.Events.html#event:DETUNE">Phaser.Sound.Events#event:DETUNE</a></li><li><a href="Phaser.Sound.Events.html#event:GLOBAL_DETUNE">Phaser.Sound.Events#event:GLOBAL_DETUNE</a></li><li><a href="Phaser.Sound.Events.html#event:GLOBAL_MUTE">Phaser.Sound.Events#event:GLOBAL_MUTE</a></li><li><a href="Phaser.Sound.Events.html#event:GLOBAL_RATE">Phaser.Sound.Events#event:GLOBAL_RATE</a></li><li><a href="Phaser.Sound.Events.html#event:GLOBAL_VOLUME">Phaser.Sound.Events#event:GLOBAL_VOLUME</a></li><li><a href="Phaser.Sound.Events.html#event:LOOP">Phaser.Sound.Events#event:LOOP</a></li><li><a href="Phaser.Sound.Events.html#event:LOOPED">Phaser.Sound.Events#event:LOOPED</a></li><li><a href="Phaser.Sound.Events.html#event:MUTE">Phaser.Sound.Events#event:MUTE</a></li><li><a href="Phaser.Sound.Events.html#event:PAUSE">Phaser.Sound.Events#event:PAUSE</a></li><li><a href="Phaser.Sound.Events.html#event:PAUSE_ALL">Phaser.Sound.Events#event:PAUSE_ALL</a></li><li><a href="Phaser.Sound.Events.html#event:PLAY">Phaser.Sound.Events#event:PLAY</a></li><li><a href="Phaser.Sound.Events.html#event:RATE">Phaser.Sound.Events#event:RATE</a></li><li><a href="Phaser.Sound.Events.html#event:RESUME">Phaser.Sound.Events#event:RESUME</a></li><li><a href="Phaser.Sound.Events.html#event:RESUME_ALL">Phaser.Sound.Events#event:RESUME_ALL</a></li><li><a href="Phaser.Sound.Events.html#event:SEEK">Phaser.Sound.Events#event:SEEK</a></li><li><a href="Phaser.Sound.Events.html#event:STOP">Phaser.Sound.Events#event:STOP</a></li><li><a href="Phaser.Sound.Events.html#event:STOP_ALL">Phaser.Sound.Events#event:STOP_ALL</a></li><li><a href="Phaser.Sound.Events.html#event:UNLOCKED">Phaser.Sound.Events#event:UNLOCKED</a></li><li><a href="Phaser.Sound.Events.html#event:VOLUME">Phaser.Sound.Events#event:VOLUME</a></li><li><a href="Phaser.Structs.Events.html#event:PROCESS_QUEUE_ADD">Phaser.Structs.Events#event:PROCESS_QUEUE_ADD</a></li><li><a href="Phaser.Structs.Events.html#event:PROCESS_QUEUE_REMOVE">Phaser.Structs.Events#event:PROCESS_QUEUE_REMOVE</a></li><li><a href="Phaser.Textures.Events.html#event:ADD">Phaser.Textures.Events#event:ADD</a></li><li><a href="Phaser.Textures.Events.html#event:ERROR">Phaser.Textures.Events#event:ERROR</a></li><li><a href="Phaser.Textures.Events.html#event:LOAD">Phaser.Textures.Events#event:LOAD</a></li><li><a href="Phaser.Textures.Events.html#event:READY">Phaser.Textures.Events#event:READY</a></li><li><a href="Phaser.Textures.Events.html#event:REMOVE">Phaser.Textures.Events#event:REMOVE</a></li><li><a href="Phaser.Tweens.Events.html#event:TIMELINE_COMPLETE">Phaser.Tweens.Events#event:TIMELINE_COMPLETE</a></li><li><a href="Phaser.Tweens.Events.html#event:TIMELINE_LOOP">Phaser.Tweens.Events#event:TIMELINE_LOOP</a></li><li><a href="Phaser.Tweens.Events.html#event:TIMELINE_PAUSE">Phaser.Tweens.Events#event:TIMELINE_PAUSE</a></li><li><a href="Phaser.Tweens.Events.html#event:TIMELINE_RESUME">Phaser.Tweens.Events#event:TIMELINE_RESUME</a></li><li><a href="Phaser.Tweens.Events.html#event:TIMELINE_START">Phaser.Tweens.Events#event:TIMELINE_START</a></li><li><a href="Phaser.Tweens.Events.html#event:TIMELINE_UPDATE">Phaser.Tweens.Events#event:TIMELINE_UPDATE</a></li><li><a href="Phaser.Tweens.Events.html#event:TWEEN_ACTIVE">Phaser.Tweens.Events#event:TWEEN_ACTIVE</a></li><li><a href="Phaser.Tweens.Events.html#event:TWEEN_COMPLETE">Phaser.Tweens.Events#event:TWEEN_COMPLETE</a></li><li><a href="Phaser.Tweens.Events.html#event:TWEEN_LOOP">Phaser.Tweens.Events#event:TWEEN_LOOP</a></li><li><a href="Phaser.Tweens.Events.html#event:TWEEN_REPEAT">Phaser.Tweens.Events#event:TWEEN_REPEAT</a></li><li><a href="Phaser.Tweens.Events.html#event:TWEEN_START">Phaser.Tweens.Events#event:TWEEN_START</a></li><li><a href="Phaser.Tweens.Events.html#event:TWEEN_STOP">Phaser.Tweens.Events#event:TWEEN_STOP</a></li><li><a href="Phaser.Tweens.Events.html#event:TWEEN_UPDATE">Phaser.Tweens.Events#event:TWEEN_UPDATE</a></li><li><a href="Phaser.Tweens.Events.html#event:TWEEN_YOYO">Phaser.Tweens.Events#event:TWEEN_YOYO</a></li><li><a href="SpinePluginEvents.html#event:COMPLETE">SpinePluginEvents#event:COMPLETE</a></li><li><a href="SpinePluginEvents.html#event:DISPOSE">SpinePluginEvents#event:DISPOSE</a></li><li><a href="SpinePluginEvents.html#event:END">SpinePluginEvents#event:END</a></li><li><a href="SpinePluginEvents.html#event:EVENT">SpinePluginEvents#event:EVENT</a></li><li><a href="SpinePluginEvents.html#event:INTERRUPTED">SpinePluginEvents#event:INTERRUPTED</a></li><li><a href="SpinePluginEvents.html#event:START">SpinePluginEvents#event:START</a></li>
				</ul>
			</li>
			
			<li class="dropdown">
				<a href="Phaser.GameObjects.html" class="dropdown-toggle" data-toggle="dropdown">Game Objects<b class="caret"></b></a>
				<ul class="dropdown-menu ">
					<li><a href="Phaser.GameObjects.GameObject.html">Base Game Object</a></li><li><a href="Phaser.GameObjects.GameObjectFactory.html">Game Object Factory</a></li><li><a href="Phaser.GameObjects.GameObjectCreator.html">Game Object Creator</a></li><li>&nbsp;</li><li><a href="Phaser.GameObjects.BitmapText.html">Bitmap Text (Static)</a></li><li><a href="Phaser.GameObjects.DynamicBitmapText.html">Bitmap Text (Dynamic)</a></li><li><a href="Phaser.GameObjects.Blitter.html">Blitter</a></li><li><a href="Phaser.GameObjects.Blitter.Bob.html">Bob (Blitter Object)</a></li><li><a href="Phaser.GameObjects.Container.html">Container</a></li><li><a href="Phaser.GameObjects.DOMElement.html">DOM Element</a></li><li><a href="Phaser.GameObjects.Extern.html">Extern</a></li><li><a href="Phaser.GameObjects.Graphics.html">Graphics</a></li><li><a href="Phaser.GameObjects.Group.html">Group</a></li><li><a href="Phaser.GameObjects.Image.html">Image</a></li><li><a href="Phaser.GameObjects.Particles.ParticleEmitter.html">Particle Emitter</a></li><li><a href="Phaser.GameObjects.Particles.ParticleEmitterManager.html">Particle Emitter Manager</a></li><li><a href="Phaser.GameObjects.PathFollower.html">Path Follower</a></li><li><a href="Phaser.GameObjects.RenderTexture.html">RenderTexture</a></li><li><a href="Phaser.GameObjects.Shape.html">Shape</a></li><li><a href="Phaser.GameObjects.Sprite.html">Sprite</a></li><li><a href="Phaser.GameObjects.Sprite3D.html">Sprite3D</a></li><li><a href="Phaser.GameObjects.Text.html">Text</a></li><li><a href="Phaser.GameObjects.TileSprite.html">TileSprite</a></li><li><a href="Phaser.GameObjects.Video.html">Video</a></li><li><a href="Phaser.GameObjects.Zone.html">Zone</a></li><li>&nbsp;</li><li><a href="Phaser.Tilemaps.Tilemap.html">Tilemap</a></li><li><a href="Phaser.Tilemaps.DynamicTilemapLayer.html">Tilemap Layer (Dynamic)</a></li><li><a href="Phaser.Tilemaps.StaticTilemapLayer.html">Tilemap Layer (Static)</a></li><li>&nbsp;</li><li><a href="Phaser.GameObjects.Arc.html">Arc</a></li><li><a href="Phaser.GameObjects.Curve.html">Curve</a></li><li><a href="Phaser.GameObjects.Ellipse.html">Ellipse</a></li><li><a href="Phaser.GameObjects.Grid.html">Grid</a></li><li><a href="Phaser.GameObjects.IsoBox.html">IsoBox</a></li><li><a href="Phaser.GameObjects.IsoTriangle.html">IsoTriangle</a></li><li><a href="Phaser.GameObjects.Line.html">Line</a></li><li><a href="Phaser.GameObjects.Polygon.html">Polygon</a></li><li><a href="Phaser.GameObjects.Rectangle.html">Rectangle</a></li><li><a href="Phaser.GameObjects.Star.html">Star</a></li><li><a href="Phaser.GameObjects.Triangle.html">Triangle</a></li><li>&nbsp;</li><li><a href="Phaser.GameObjects.Rope.html">Rope (WebGL only)</a></li><li><a href="Phaser.GameObjects.Shader.html">Shader (WebGL only)</a></li><li><a href="Phaser.GameObjects.LightsPlugin.html">Lights (WebGL only)</a></li><li><a href="Phaser.GameObjects.Mesh.html">Mesh (WebGL only)</a></li><li><a href="Phaser.GameObjects.Quad.html">Quad (WebGL only)</a></li>
				</ul>
			</li>
			
			<li class="dropdown">
				<a href="Phaser.Physics.html" class="dropdown-toggle" data-toggle="dropdown">Physics<b class="caret"></b></a>
				<ul class="dropdown-menu ">
					<li><a href="Phaser.Physics.Arcade.html"><strong>Arcade Physics</strong></a></li><li><a href="Phaser.Physics.Arcade.Factory.html">Arcade Physics Factory</a></li><li><a href="Phaser.Physics.Arcade.World.html">Arcade Physics World</a></li><li><a href="Phaser.Physics.Arcade.Image.html">Arcade Physics Image</a></li><li><a href="Phaser.Physics.Arcade.Sprite.html">Arcade Physics Sprite</a></li><li><a href="Phaser.Physics.Arcade.Group.html">Arcade Physics Group</a></li><li>&nbsp;</li><li><a href="Phaser.Physics.Matter.MatterPhysics.html"><strong>Matter Physics</strong></a></li><li><a href="Phaser.Physics.Matter.Factory.html">Matter Physics Factory</a></li><li><a href="Phaser.Physics.Matter.World.html">Matter Physics World</a></li><li><a href="Phaser.Physics.Matter.Image.html">Matter Physics Image</a></li><li><a href="Phaser.Physics.Matter.Sprite.html">Matter Physics Sprite</a></li><li><a href="Phaser.Physics.Matter.PointerConstraint.html">Matter Physics Pointer Constraint</a></li>
				</ul>
			</li>
			
			<li class="dropdown">
				<a href="Phaser.Scene.html" class="dropdown-toggle" data-toggle="dropdown">Scene<b class="caret"></b></a>
				<ul class="dropdown-menu ">
					<li><a href="Phaser.Scene.html">Scene</a></li><li><a href="Phaser.Scenes.ScenePlugin.html">Scene Plugin</a></li><li><a href="Phaser.Scenes.Systems.html">Scene Systems</a></li><li><a href="Phaser.Types.Scenes.html#.SettingsConfig">Scene Configuration</a></li><li>&nbsp;</li><li><a href="Phaser.GameObjects.GameObjectFactory.html">add</a></li><li><a href="Phaser.Animations.AnimationManager.html">anims</a></li><li><a href="Phaser.Cache.CacheManager.html">cache</a></li><li><a href="Phaser.Cameras.Scene2D.CameraManager.html">cameras</a></li><li><a href="Phaser.GameObjects.DisplayList.html">children</a></li><li><a href="Phaser.Data.DataManager.html">data</a></li><li><a href="Phaser.Events.EventEmitter.html">events</a></li><li><a href="Phaser.FacebookInstantGamesPlugin.html">facebook</a></li><li><a href="Phaser.Game.html">game</a></li><li><a href="Phaser.Physics.Impact.ImpactPhysics.html">impact</a></li><li><a href="Phaser.Input.InputPlugin.html">input</a></li><li><a href="Phaser.GameObjects.LightsManager.html">lights</a></li><li><a href="Phaser.Loader.LoaderPlugin.html">load</a></li><li><a href="Phaser.GameObjects.GameObjectCreator.html">make</a></li><li><a href="Phaser.Physics.Matter.MatterPhysics.html">matter</a></li><li><a href="Phaser.Physics.Arcade.ArcadePhysics.html">physics</a></li><li><a href="Phaser.Plugins.PluginManager.html">plugins</a></li><li><a href="Phaser.Data.DataManager.html">registry</a></li><li><a href="Phaser.Scale.ScaleManager.html">scale</a></li><li><a href="Phaser.Scenes.ScenePlugin.html">scene</a></li><li><a href="Phaser.Sound.BaseSoundManager.html">sound</a></li><li><a href="Phaser.Scenes.Systems.html">sys</a></li><li><a href="Phaser.Textures.TextureManager.html">textures</a></li><li><a href="Phaser.Time.Clock.html">time</a></li><li><a href="Phaser.Tweens.TweenManager.html">tweens</a></li>
				</ul>
			</li>
			
		</ul>
        
            <div class="col-sm-3 col-md-3">
                <form class="navbar-form" role="search">
                    <div class="input-group">
                        <input type="text" class="form-control loading" placeholder="Search" name="q" id="search-input" disabled>
                        <div class="input-group-btn">
                            <button class="btn btn-default" id="search-submit" disabled><i class="glyphicon glyphicon-search"></i></button>
                        </div>
                    </div>
                </form>
            </div>
        
	</div>

</div>
</div>

<div class="container" id="toc-content">
<div class="row">

	
	<div class="col-md-8">
	
		<div id="main">
			

	<h1 class="page-title">Class: Camera</h1>
<section>

<header>
    
        <h2>
            <span class="ancestors"><a href="Phaser.html">Phaser</a><a href="Phaser.Cameras.html">.Cameras</a><a href="Phaser.Cameras.Scene2D.html">.Scene2D</a>.</span>
        
        Camera
        </h2>
        
            <div class="class-description"><p>A Camera.</p>
<p>The Camera is the way in which all games are rendered in Phaser. They provide a view into your game world,
and can be positioned, rotated, zoomed and scrolled accordingly.</p>
<p>A Camera consists of two elements: The viewport and the scroll values.</p>
<p>The viewport is the physical position and size of the Camera within your game. Cameras, by default, are
created the same size as your game, but their position and size can be set to anything. This means if you
wanted to create a camera that was 320x200 in size, positioned in the bottom-right corner of your game,
you'd adjust the viewport to do that (using methods like <code>setViewport</code> and <code>setSize</code>).</p>
<p>If you wish to change where the Camera is looking in your game, then you scroll it. You can do this
via the properties <code>scrollX</code> and <code>scrollY</code> or the method <code>setScroll</code>. Scrolling has no impact on the
viewport, and changing the viewport has no impact on the scrolling.</p>
<p>By default a Camera will render all Game Objects it can see. You can change this using the <code>ignore</code> method,
allowing you to filter Game Objects out on a per-Camera basis.</p>
<p>A Camera also has built-in special effects including Fade, Flash and Camera Shake.</p></div>
        
    
</header>


<article>
    <div class="container-overview">
    
        
<hr>
<dt>
    <h4 class="name" id="Camera"><span class="type-signature"></span>new Camera(x, y, width, height)</h4>
    
    
</dt>
<dd>

    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>x</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>



            
            </td>

            

            

            <td class="description last"><p>The x position of the Camera, relative to the top-left of the game canvas.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>y</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>



            
            </td>

            

            

            <td class="description last"><p>The y position of the Camera, relative to the top-left of the game canvas.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>width</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>



            
            </td>

            

            

            <td class="description last"><p>The width of the Camera, in pixels.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>height</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>



            
            </td>

            

            

            <td class="description last"><p>The height of the Camera, in pixels.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js">src/cameras/2d/Camera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js#L18">Line 18</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    

    
</dd>

    
    </div>

    
        <h3 class="subsection-title">Extends</h3>

        


    <ul>
        <li><a href="Phaser.Cameras.Scene2D.BaseCamera.html">Phaser.Cameras.Scene2D.BaseCamera</a></li>
    
        <li><a href="Phaser.GameObjects.Components.Flip.html">Phaser.GameObjects.Components.Flip</a></li>
    
        <li><a href="Phaser.GameObjects.Components.Tint.html">Phaser.GameObjects.Components.Tint</a></li>
    </ul>


    

    

    

    

    

    
        <h3 class="subsection-title">Members</h3>

        <dl>
            
<hr>
<dt class="name" id="alpha">
    <h4 id="alpha"><span class="type-signature"></span>alpha<span class="type-signature"> :number</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>The Camera alpha value. Setting this property impacts every single object that this Camera
renders. You can either set the property directly, i.e. via a Tween, to fade a Camera in or out,
or via the chainable <code>setAlpha</code> method instead.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.11.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#alpha">Phaser.Cameras.Scene2D.BaseCamera#alpha</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	
	<dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
	<dd class="tag-default">
		<ul class="dummy">
			<li>1</li>
		</ul>
	</dd>
	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L411">Line 411</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="alphaBottomLeft">
    <h4 id="alphaBottomLeft"><span class="type-signature"></span>alphaBottomLeft<span class="type-signature"> :number</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>The alpha value starting from the bottom-left of the Game Object.
This value is interpolated from the corner to the center of the Game Object.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.GameObjects.Components.Alpha.html#alphaBottomLeft">Phaser.GameObjects.Components.Alpha#alphaBottomLeft</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/gameobjects/components/Alpha.js">src/gameobjects/components/Alpha.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/gameobjects/components/Alpha.js#L227">Line 227</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="alphaBottomRight">
    <h4 id="alphaBottomRight"><span class="type-signature"></span>alphaBottomRight<span class="type-signature"> :number</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>The alpha value starting from the bottom-right of the Game Object.
This value is interpolated from the corner to the center of the Game Object.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.GameObjects.Components.Alpha.html#alphaBottomRight">Phaser.GameObjects.Components.Alpha#alphaBottomRight</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/gameobjects/components/Alpha.js">src/gameobjects/components/Alpha.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/gameobjects/components/Alpha.js#L257">Line 257</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="alphaTopLeft">
    <h4 id="alphaTopLeft"><span class="type-signature"></span>alphaTopLeft<span class="type-signature"> :number</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>The alpha value starting from the top-left of the Game Object.
This value is interpolated from the corner to the center of the Game Object.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.GameObjects.Components.Alpha.html#alphaTopLeft">Phaser.GameObjects.Components.Alpha#alphaTopLeft</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/gameobjects/components/Alpha.js">src/gameobjects/components/Alpha.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/gameobjects/components/Alpha.js#L167">Line 167</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="alphaTopRight">
    <h4 id="alphaTopRight"><span class="type-signature"></span>alphaTopRight<span class="type-signature"> :number</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>The alpha value starting from the top-right of the Game Object.
This value is interpolated from the corner to the center of the Game Object.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.GameObjects.Components.Alpha.html#alphaTopRight">Phaser.GameObjects.Components.Alpha#alphaTopRight</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/gameobjects/components/Alpha.js">src/gameobjects/components/Alpha.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/gameobjects/components/Alpha.js#L197">Line 197</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="backgroundColor">
    <h4 id="backgroundColor"><span class="type-signature"></span>backgroundColor<span class="type-signature"> :<a href="Phaser.Display.Color.html">Phaser.Display.Color</a></span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>The background color of this Camera. Only used if <code>transparent</code> is <code>false</code>.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Display.Color.html">Phaser.Display.Color</a></span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#backgroundColor">Phaser.Cameras.Scene2D.BaseCamera#backgroundColor</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L402">Line 402</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="cameraManager">
    <h4 id="cameraManager"><span class="type-signature"></span>cameraManager<span class="type-signature"> :<a href="Phaser.Cameras.Scene2D.CameraManager.html">Phaser.Cameras.Scene2D.CameraManager</a></span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>A reference to the Scene's Camera Manager to which this Camera belongs.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Cameras.Scene2D.CameraManager.html">Phaser.Cameras.Scene2D.CameraManager</a></span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.17.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#cameraManager">Phaser.Cameras.Scene2D.BaseCamera#cameraManager</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L106">Line 106</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="canvas">
    <h4 id="canvas"><span class="type-signature"></span>canvas<span class="type-signature"> :HTMLCanvasElement</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>If this Camera has been set to render to a texture then this holds a reference
to the HTML Canvas Element that the Camera is drawing to.</p>
<p>Enable texture rendering using the method <code>setRenderToTexture</code>.</p>
<p>This is only populated if Phaser is running with the Canvas Renderer.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">HTMLCanvasElement</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.13.0</dt>
	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js">src/cameras/2d/Camera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js#L239">Line 239</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="centerX">
    <h4 id="centerX"><span class="type-signature">&lt;readonly> </span>centerX<span class="type-signature"> :number</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>The horizontal position of the center of the Camera's viewport, relative to the left of the game canvas.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.10.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#centerX">Phaser.Cameras.Scene2D.BaseCamera#centerX</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L1833">Line 1833</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="centerY">
    <h4 id="centerY"><span class="type-signature">&lt;readonly> </span>centerY<span class="type-signature"> :number</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>The vertical position of the center of the Camera's viewport, relative to the top of the game canvas.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.10.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#centerY">Phaser.Cameras.Scene2D.BaseCamera#centerY</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L1850">Line 1850</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="context">
    <h4 id="context"><span class="type-signature"></span>context<span class="type-signature"> :CanvasRenderingContext2D</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>If this Camera has been set to render to a texture then this holds a reference
to the Rendering Context belonging to the Canvas element the Camera is drawing to.</p>
<p>Enable texture rendering using the method <code>setRenderToTexture</code>.</p>
<p>This is only populated if Phaser is running with the Canvas Renderer.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">CanvasRenderingContext2D</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.13.0</dt>
	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js">src/cameras/2d/Camera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js#L253">Line 253</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="deadzone">
    <h4 id="deadzone"><span class="type-signature">&lt;nullable> </span>deadzone<span class="type-signature"> :<a href="Phaser.Geom.Rectangle.html">Phaser.Geom.Rectangle</a></span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>The Camera dead zone.</p>
<p>The deadzone is only used when the camera is following a target.</p>
<p>It defines a rectangular region within which if the target is present, the camera will not scroll.
If the target moves outside of this area, the camera will begin scrolling in order to follow it.</p>
<p>The <code>lerp</code> values that you can set for a follower target also apply when using a deadzone.</p>
<p>You can directly set this property to be an instance of a Rectangle. Or, you can use the
<code>setDeadzone</code> method for a chainable approach.</p>
<p>The rectangle you provide can have its dimensions adjusted dynamically, however, please
note that its position is updated every frame, as it is constantly re-centered on the cameras mid point.</p>
<p>Calling <code>setDeadzone</code> with no arguments will reset an active deadzone, as will setting this property
to <code>null</code>.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Geom.Rectangle.html">Phaser.Geom.Rectangle</a></span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.11.0</dt>
	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js">src/cameras/2d/Camera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js#L169">Line 169</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="dirty">
    <h4 id="dirty"><span class="type-signature"></span>dirty<span class="type-signature"> :boolean</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>Is this Camera dirty?</p>
<p>A dirty Camera has had either its viewport size, bounds, scroll, rotation or zoom levels changed since the last frame.</p>
<p>This flag is cleared during the <code>postRenderCamera</code> method of the renderer.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">boolean</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.11.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#dirty">Phaser.Cameras.Scene2D.BaseCamera#dirty</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	
	<dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
	<dd class="tag-default">
		<ul class="dummy">
			<li>true</li>
		</ul>
	</dd>
	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L196">Line 196</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="disableCull">
    <h4 id="disableCull"><span class="type-signature"></span>disableCull<span class="type-signature"> :boolean</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>Should the camera cull Game Objects before checking them for input hit tests?
In some special cases it may be beneficial to disable this.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">boolean</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#disableCull">Phaser.Cameras.Scene2D.BaseCamera#disableCull</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	
	<dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
	<dd class="tag-default">
		<ul class="dummy">
			<li>false</li>
		</ul>
	</dd>
	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L422">Line 422</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="displayHeight">
    <h4 id="displayHeight"><span class="type-signature">&lt;readonly> </span>displayHeight<span class="type-signature"> :number</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>The displayed height of the camera viewport, factoring in the camera zoom level.</p>
<p>If a camera has a viewport height of 600 and a zoom of 0.5 then its display height
would be 1200, as it's displaying twice as many pixels as zoom level 1.</p>
<p>Equally, a camera with a height of 600 and zoom of 2 would have a display height
of 300 pixels.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.11.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#displayHeight">Phaser.Cameras.Scene2D.BaseCamera#displayHeight</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L1890">Line 1890</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="displayWidth">
    <h4 id="displayWidth"><span class="type-signature">&lt;readonly> </span>displayWidth<span class="type-signature"> :number</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>The displayed width of the camera viewport, factoring in the camera zoom level.</p>
<p>If a camera has a viewport width of 800 and a zoom of 0.5 then its display width
would be 1600, as it's displaying twice as many pixels as zoom level 1.</p>
<p>Equally, a camera with a width of 800 and zoom of 2 would have a display width
of 400 pixels.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.11.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#displayWidth">Phaser.Cameras.Scene2D.BaseCamera#displayWidth</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L1867">Line 1867</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="fadeEffect">
    <h4 id="fadeEffect"><span class="type-signature"></span>fadeEffect<span class="type-signature"> :<a href="Phaser.Cameras.Scene2D.Effects.Fade.html">Phaser.Cameras.Scene2D.Effects.Fade</a></span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>The Camera Fade effect handler.
To fade this camera see the <code>Camera.fade</code> methods.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Effects.Fade.html">Phaser.Cameras.Scene2D.Effects.Fade</a></span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.5.0</dt>
	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js">src/cameras/2d/Camera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js#L80">Line 80</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="flashEffect">
    <h4 id="flashEffect"><span class="type-signature"></span>flashEffect<span class="type-signature"> :<a href="Phaser.Cameras.Scene2D.Effects.Flash.html">Phaser.Cameras.Scene2D.Effects.Flash</a></span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>The Camera Flash effect handler.
To flash this camera see the <code>Camera.flash</code> method.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Effects.Flash.html">Phaser.Cameras.Scene2D.Effects.Flash</a></span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.5.0</dt>
	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js">src/cameras/2d/Camera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js#L90">Line 90</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="flipX">
    <h4 id="flipX"><span class="type-signature"></span>flipX<span class="type-signature"> :boolean</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>The horizontally flipped state of the Game Object.</p>
<p>A Game Object that is flipped horizontally will render inversed on the horizontal axis.
Flipping always takes place from the middle of the texture and does not impact the scale value.
If this Game Object has a physics body, it will not change the body. This is a rendering toggle only.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">boolean</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.GameObjects.Components.Flip.html#flipX">Phaser.GameObjects.Components.Flip#flipX</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	
	<dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
	<dd class="tag-default">
		<ul class="dummy">
			<li>false</li>
		</ul>
	</dd>
	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/gameobjects/components/Flip.js">src/gameobjects/components/Flip.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/gameobjects/components/Flip.js#L17">Line 17</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="flipY">
    <h4 id="flipY"><span class="type-signature"></span>flipY<span class="type-signature"> :boolean</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>The vertically flipped state of the Game Object.</p>
<p>A Game Object that is flipped vertically will render inversed on the vertical axis (i.e. upside down)
Flipping always takes place from the middle of the texture and does not impact the scale value.
If this Game Object has a physics body, it will not change the body. This is a rendering toggle only.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">boolean</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.GameObjects.Components.Flip.html#flipY">Phaser.GameObjects.Components.Flip#flipY</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	
	<dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
	<dd class="tag-default">
		<ul class="dummy">
			<li>false</li>
		</ul>
	</dd>
	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/gameobjects/components/Flip.js">src/gameobjects/components/Flip.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/gameobjects/components/Flip.js#L31">Line 31</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="followOffset">
    <h4 id="followOffset"><span class="type-signature"></span>followOffset<span class="type-signature"> :<a href="Phaser.Math.Vector2.html">Phaser.Math.Vector2</a></span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>The values stored in this property are subtracted from the Camera targets position, allowing you to
offset the camera from the actual target x/y coordinates by this amount.
Can also be set via <code>setFollowOffset</code> or as part of the <code>startFollow</code> call.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Math.Vector2.html">Phaser.Math.Vector2</a></span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.9.0</dt>
	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js">src/cameras/2d/Camera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js#L158">Line 158</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="framebuffer">
    <h4 id="framebuffer"><span class="type-signature">&lt;nullable> </span>framebuffer<span class="type-signature"> :WebGLFramebuffer</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>If this Camera has been set to render to a texture then this holds a reference
to the GL Frame Buffer belonging the Camera is drawing to.</p>
<p>Enable texture rendering using the method <code>setRenderToTexture</code>.</p>
<p>This is only set if Phaser is running with the WebGL Renderer.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">WebGLFramebuffer</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.13.0</dt>
	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js">src/cameras/2d/Camera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js#L281">Line 281</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="glTexture">
    <h4 id="glTexture"><span class="type-signature">&lt;nullable> </span>glTexture<span class="type-signature"> :WebGLTexture</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>If this Camera has been set to render to a texture then this holds a reference
to the GL Texture belonging the Camera is drawing to.</p>
<p>Enable texture rendering using the method <code>setRenderToTexture</code>.</p>
<p>This is only set if Phaser is running with the WebGL Renderer.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">WebGLTexture</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.13.0</dt>
	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js">src/cameras/2d/Camera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js#L267">Line 267</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="height">
    <h4 id="height"><span class="type-signature"></span>height<span class="type-signature"> :number</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>The height of the Camera viewport, in pixels.</p>
<p>The viewport is the area into which the Camera renders. Setting the viewport does
not restrict where the Camera can scroll to.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#height">Phaser.Cameras.Scene2D.BaseCamera#height</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L1686">Line 1686</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="id">
    <h4 id="id"><span class="type-signature">&lt;readonly> </span>id<span class="type-signature"> :integer</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>The Camera ID. Assigned by the Camera Manager and used to handle camera exclusion.
This value is a bitmask.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">integer</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.11.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#id">Phaser.Cameras.Scene2D.BaseCamera#id</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L115">Line 115</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="inputEnabled">
    <h4 id="inputEnabled"><span class="type-signature"></span>inputEnabled<span class="type-signature"> :boolean</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>Does this Camera allow the Game Objects it renders to receive input events?</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">boolean</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	

    

    

    

    

	

	

	

	

	
	<dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
	<dd class="tag-default">
		<ul class="dummy">
			<li>true</li>
		</ul>
	</dd>
	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js">src/cameras/2d/Camera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js#L70">Line 70</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="isTinted">
    <h4 id="isTinted"><span class="type-signature">&lt;readonly> </span>isTinted<span class="type-signature"> :boolean</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>Does this Game Object have a tint applied to it or not?</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">boolean</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.11.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.GameObjects.Components.Tint.html#isTinted">Phaser.GameObjects.Components.Tint#isTinted</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/gameobjects/components/Tint.js">src/gameobjects/components/Tint.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/gameobjects/components/Tint.js#L314">Line 314</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="lerp">
    <h4 id="lerp"><span class="type-signature"></span>lerp<span class="type-signature"> :<a href="Phaser.Math.Vector2.html">Phaser.Math.Vector2</a></span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>The linear interpolation value to use when following a target.</p>
<p>Can also be set via <code>setLerp</code> or as part of the <code>startFollow</code> call.</p>
<p>The default values of 1 means the camera will instantly snap to the target coordinates.
A lower value, such as 0.1 means the camera will more slowly track the target, giving
a smooth transition. You can set the horizontal and vertical values independently, and also
adjust this value in real-time during your game.</p>
<p>Be sure to keep the value between 0 and 1. A value of zero will disable tracking on that axis.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Math.Vector2.html">Phaser.Math.Vector2</a></span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.9.0</dt>
	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js">src/cameras/2d/Camera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js#L140">Line 140</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="mask">
    <h4 id="mask"><span class="type-signature">&lt;nullable> </span>mask<span class="type-signature"> :<a href="Phaser.Display.Masks.BitmapMask.html">Phaser.Display.Masks.BitmapMask</a>|<a href="Phaser.Display.Masks.GeometryMask.html">Phaser.Display.Masks.GeometryMask</a></span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>The Mask this Camera is using during render.
Set the mask using the <code>setMask</code> method. Remove the mask using the <code>clearMask</code> method.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Display.Masks.BitmapMask.html">Phaser.Display.Masks.BitmapMask</a></span>
|

<span class="param-type"><a href="Phaser.Display.Masks.GeometryMask.html">Phaser.Display.Masks.GeometryMask</a></span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.17.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#mask">Phaser.Cameras.Scene2D.BaseCamera#mask</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L504">Line 504</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="midPoint">
    <h4 id="midPoint"><span class="type-signature">&lt;readonly> </span>midPoint<span class="type-signature"> :<a href="Phaser.Math.Vector2.html">Phaser.Math.Vector2</a></span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>The mid-point of the Camera in 'world' coordinates.</p>
<p>Use it to obtain exactly where in the world the center of the camera is currently looking.</p>
<p>This value is updated in the preRender method, after the scroll values and follower
have been processed.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Math.Vector2.html">Phaser.Math.Vector2</a></span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.11.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#midPoint">Phaser.Cameras.Scene2D.BaseCamera#midPoint</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L444">Line 444</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="name">
    <h4 id="name"><span class="type-signature"></span>name<span class="type-signature"> :string</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>The name of the Camera. This is left empty for your own use.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">string</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#name">Phaser.Cameras.Scene2D.BaseCamera#name</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	
	<dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
	<dd class="tag-default">
		<ul class="dummy">
			<li>''</li>
		</ul>
	</dd>
	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L126">Line 126</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="originX">
    <h4 id="originX"><span class="type-signature"></span>originX<span class="type-signature"> :number</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>The horizontal origin of rotation for this Camera.</p>
<p>By default the camera rotates around the center of the viewport.</p>
<p>Changing the origin allows you to adjust the point in the viewport from which rotation happens.
A value of 0 would rotate from the top-left of the viewport. A value of 1 from the bottom right.</p>
<p>See <code>setOrigin</code> to set both origins in a single, chainable call.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.11.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#originX">Phaser.Cameras.Scene2D.BaseCamera#originX</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	
	<dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
	<dd class="tag-default">
		<ul class="dummy">
			<li>0.5</li>
		</ul>
	</dd>
	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L459">Line 459</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="originY">
    <h4 id="originY"><span class="type-signature"></span>originY<span class="type-signature"> :number</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>The vertical origin of rotation for this Camera.</p>
<p>By default the camera rotates around the center of the viewport.</p>
<p>Changing the origin allows you to adjust the point in the viewport from which rotation happens.
A value of 0 would rotate from the top-left of the viewport. A value of 1 from the bottom right.</p>
<p>See <code>setOrigin</code> to set both origins in a single, chainable call.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.11.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#originY">Phaser.Cameras.Scene2D.BaseCamera#originY</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	
	<dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
	<dd class="tag-default">
		<ul class="dummy">
			<li>0.5</li>
		</ul>
	</dd>
	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L476">Line 476</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="panEffect">
    <h4 id="panEffect"><span class="type-signature"></span>panEffect<span class="type-signature"> :<a href="Phaser.Cameras.Scene2D.Effects.Pan.html">Phaser.Cameras.Scene2D.Effects.Pan</a></span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>The Camera Pan effect handler.
To pan this camera see the <code>Camera.pan</code> method.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Effects.Pan.html">Phaser.Cameras.Scene2D.Effects.Pan</a></span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.11.0</dt>
	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js">src/cameras/2d/Camera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js#L110">Line 110</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="pipeline">
    <h4 id="pipeline"><span class="type-signature"></span>pipeline<span class="type-signature"> :any</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>If this Camera has been set to render to a texture and to use a custom pipeline,
then this holds a reference to the pipeline the Camera is drawing with.</p>
<p>Enable texture rendering using the method <code>setRenderToTexture</code>.</p>
<p>This is only set if Phaser is running with the WebGL Renderer.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">any</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.13.0</dt>
	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js">src/cameras/2d/Camera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js#L295">Line 295</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="renderToGame">
    <h4 id="renderToGame"><span class="type-signature"></span>renderToGame<span class="type-signature"> :boolean</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>If this Camera is rendering to a texture (via <code>setRenderToTexture</code>) then you
have the option to control if it should also render to the Game canvas as well.</p>
<p>By default, a Camera will render both to its texture and to the Game canvas.</p>
<p>However, if you set ths property to <code>false</code> it will only render to the texture
and skip rendering to the Game canvas.</p>
<p>Setting this property if the Camera isn't rendering to a texture has no effect.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">boolean</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.23.0</dt>
	

	

    

    

    

    

	

	

	

	

	
	<dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
	<dd class="tag-default">
		<ul class="dummy">
			<li>true</li>
		</ul>
	</dd>
	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js">src/cameras/2d/Camera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js#L221">Line 221</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="renderToTexture">
    <h4 id="renderToTexture"><span class="type-signature"></span>renderToTexture<span class="type-signature"> :boolean</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>Is this Camera rendering directly to the canvas or to a texture?</p>
<p>Enable rendering to texture with the method <code>setRenderToTexture</code> (just enabling this boolean won't be enough)</p>
<p>Once enabled you can toggle it by switching this property.</p>
<p>To properly remove a render texture you should call the <code>clearRenderToTexture()</code> method.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">boolean</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.13.0</dt>
	

	

    

    

    

    

	

	

	

	

	
	<dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
	<dd class="tag-default">
		<ul class="dummy">
			<li>false</li>
		</ul>
	</dd>
	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js">src/cameras/2d/Camera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js#L205">Line 205</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="resolution">
    <h4 id="resolution"><span class="type-signature">&lt;readonly> </span>resolution<span class="type-signature"> :number</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>This property is un-used in v3.16.</p>
<p>The resolution of the Game, used in most Camera calculations.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.12.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#resolution">Phaser.Cameras.Scene2D.BaseCamera#resolution</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	
	<dt class="important tag-deprecated method-doc-label method-doc-details-label">Deprecated:</dt>
	
    <dd class="yes-def tag-deprecated">
        <ul class="dummy">
            <li>Yes</li>
        </ul>
    </dd>
    
    

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L136">Line 136</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="rotateToEffect">
    <h4 id="rotateToEffect"><span class="type-signature"></span>rotateToEffect<span class="type-signature"> :<a href="Phaser.Cameras.Scene2D.Effects.RotateTo.html">Phaser.Cameras.Scene2D.Effects.RotateTo</a></span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>The Camera Rotate To effect handler.
To rotate this camera see the <code>Camera.rotateTo</code> method.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Effects.RotateTo.html">Phaser.Cameras.Scene2D.Effects.RotateTo</a></span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.23.0</dt>
	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js">src/cameras/2d/Camera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js#L120">Line 120</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="roundPixels">
    <h4 id="roundPixels"><span class="type-signature"></span>roundPixels<span class="type-signature"> :boolean</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>Should this camera round its pixel values to integers?</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">boolean</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#roundPixels">Phaser.Cameras.Scene2D.BaseCamera#roundPixels</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	
	<dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
	<dd class="tag-default">
		<ul class="dummy">
			<li>false</li>
		</ul>
	</dd>
	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L149">Line 149</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="scaleManager">
    <h4 id="scaleManager"><span class="type-signature"></span>scaleManager<span class="type-signature"> :<a href="Phaser.Scale.ScaleManager.html">Phaser.Scale.ScaleManager</a></span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>A reference to the Game Scale Manager.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Scale.ScaleManager.html">Phaser.Scale.ScaleManager</a></span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.16.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#scaleManager">Phaser.Cameras.Scene2D.BaseCamera#scaleManager</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L97">Line 97</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="scene">
    <h4 id="scene"><span class="type-signature"></span>scene<span class="type-signature"> :<a href="Phaser.Scene.html">Phaser.Scene</a></span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>A reference to the Scene this camera belongs to.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Scene.html">Phaser.Scene</a></span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#scene">Phaser.Cameras.Scene2D.BaseCamera#scene</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L79">Line 79</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="sceneManager">
    <h4 id="sceneManager"><span class="type-signature"></span>sceneManager<span class="type-signature"> :<a href="Phaser.Scenes.SceneManager.html">Phaser.Scenes.SceneManager</a></span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>A reference to the Game Scene Manager.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Scenes.SceneManager.html">Phaser.Scenes.SceneManager</a></span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.12.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#sceneManager">Phaser.Cameras.Scene2D.BaseCamera#sceneManager</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L88">Line 88</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="scrollX">
    <h4 id="scrollX"><span class="type-signature"></span>scrollX<span class="type-signature"> :number</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>The horizontal scroll position of this Camera.</p>
<p>Change this value to cause the Camera to scroll around your Scene.</p>
<p>Alternatively, setting the Camera to follow a Game Object, via the <code>startFollow</code> method,
will automatically adjust the Camera scroll values accordingly.</p>
<p>You can set the bounds within which the Camera can scroll via the <code>setBounds</code> method.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#scrollX">Phaser.Cameras.Scene2D.BaseCamera#scrollX</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	
	<dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
	<dd class="tag-default">
		<ul class="dummy">
			<li>0</li>
		</ul>
	</dd>
	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L1712">Line 1712</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="scrollY">
    <h4 id="scrollY"><span class="type-signature"></span>scrollY<span class="type-signature"> :number</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>The vertical scroll position of this Camera.</p>
<p>Change this value to cause the Camera to scroll around your Scene.</p>
<p>Alternatively, setting the Camera to follow a Game Object, via the <code>startFollow</code> method,
will automatically adjust the Camera scroll values accordingly.</p>
<p>You can set the bounds within which the Camera can scroll via the <code>setBounds</code> method.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#scrollY">Phaser.Cameras.Scene2D.BaseCamera#scrollY</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	
	<dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
	<dd class="tag-default">
		<ul class="dummy">
			<li>0</li>
		</ul>
	</dd>
	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L1742">Line 1742</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="shakeEffect">
    <h4 id="shakeEffect"><span class="type-signature"></span>shakeEffect<span class="type-signature"> :<a href="Phaser.Cameras.Scene2D.Effects.Shake.html">Phaser.Cameras.Scene2D.Effects.Shake</a></span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>The Camera Shake effect handler.
To shake this camera see the <code>Camera.shake</code> method.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Effects.Shake.html">Phaser.Cameras.Scene2D.Effects.Shake</a></span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.5.0</dt>
	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js">src/cameras/2d/Camera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js#L100">Line 100</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="tint">
    <h4 id="tint"><span class="type-signature"></span>tint<span class="type-signature"> :integer</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>The tint value being applied to the whole of the Game Object.
This property is a setter-only. Use the properties <code>tintTopLeft</code> etc to read the current tint value.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">integer</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.GameObjects.Components.Tint.html#tint">Phaser.GameObjects.Components.Tint#tint</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/gameobjects/components/Tint.js">src/gameobjects/components/Tint.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/gameobjects/components/Tint.js#L297">Line 297</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="tintBottomLeft">
    <h4 id="tintBottomLeft"><span class="type-signature"></span>tintBottomLeft<span class="type-signature"> :integer</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>The tint value being applied to the bottom-left of the Game Object.
This value is interpolated from the corner to the center of the Game Object.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">integer</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.GameObjects.Components.Tint.html#tintBottomLeft">Phaser.GameObjects.Components.Tint#tintBottomLeft</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/gameobjects/components/Tint.js">src/gameobjects/components/Tint.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/gameobjects/components/Tint.js#L249">Line 249</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="tintBottomRight">
    <h4 id="tintBottomRight"><span class="type-signature"></span>tintBottomRight<span class="type-signature"> :integer</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>The tint value being applied to the bottom-right of the Game Object.
This value is interpolated from the corner to the center of the Game Object.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">integer</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.GameObjects.Components.Tint.html#tintBottomRight">Phaser.GameObjects.Components.Tint#tintBottomRight</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/gameobjects/components/Tint.js">src/gameobjects/components/Tint.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/gameobjects/components/Tint.js#L273">Line 273</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="tintFill">
    <h4 id="tintFill"><span class="type-signature"></span>tintFill<span class="type-signature"> :boolean</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>Fill or additive?</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">boolean</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.11.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.GameObjects.Components.Tint.html#tintFill">Phaser.GameObjects.Components.Tint#tintFill</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	
	<dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
	<dd class="tag-default">
		<ul class="dummy">
			<li>false</li>
		</ul>
	</dd>
	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/gameobjects/components/Tint.js">src/gameobjects/components/Tint.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/gameobjects/components/Tint.js#L83">Line 83</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="tintTopLeft">
    <h4 id="tintTopLeft"><span class="type-signature"></span>tintTopLeft<span class="type-signature"> :integer</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>The tint value being applied to the top-left of the Game Object.
This value is interpolated from the corner to the center of the Game Object.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">integer</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.GameObjects.Components.Tint.html#tintTopLeft">Phaser.GameObjects.Components.Tint#tintTopLeft</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/gameobjects/components/Tint.js">src/gameobjects/components/Tint.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/gameobjects/components/Tint.js#L201">Line 201</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="tintTopRight">
    <h4 id="tintTopRight"><span class="type-signature"></span>tintTopRight<span class="type-signature"> :integer</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>The tint value being applied to the top-right of the Game Object.
This value is interpolated from the corner to the center of the Game Object.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">integer</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.GameObjects.Components.Tint.html#tintTopRight">Phaser.GameObjects.Components.Tint#tintTopRight</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/gameobjects/components/Tint.js">src/gameobjects/components/Tint.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/gameobjects/components/Tint.js#L225">Line 225</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="transparent">
    <h4 id="transparent"><span class="type-signature"></span>transparent<span class="type-signature"> :boolean</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>Does this Camera have a transparent background?</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">boolean</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#transparent">Phaser.Cameras.Scene2D.BaseCamera#transparent</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	
	<dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
	<dd class="tag-default">
		<ul class="dummy">
			<li>true</li>
		</ul>
	</dd>
	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L392">Line 392</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="useBounds">
    <h4 id="useBounds"><span class="type-signature"></span>useBounds<span class="type-signature"> :boolean</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>Is this Camera using a bounds to restrict scrolling movement?</p>
<p>Set this property along with the bounds via <code>Camera.setBounds</code>.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">boolean</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#useBounds">Phaser.Cameras.Scene2D.BaseCamera#useBounds</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	
	<dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
	<dd class="tag-default">
		<ul class="dummy">
			<li>false</li>
		</ul>
	</dd>
	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L171">Line 171</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="visible">
    <h4 id="visible"><span class="type-signature"></span>visible<span class="type-signature"> :boolean</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>Is this Camera visible or not?</p>
<p>A visible camera will render and perform input tests.
An invisible camera will not render anything and will skip input tests.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">boolean</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.10.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#visible">Phaser.Cameras.Scene2D.BaseCamera#visible</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	
	<dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
	<dd class="tag-default">
		<ul class="dummy">
			<li>true</li>
		</ul>
	</dd>
	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L159">Line 159</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="width">
    <h4 id="width"><span class="type-signature"></span>width<span class="type-signature"> :number</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>The width of the Camera viewport, in pixels.</p>
<p>The viewport is the area into which the Camera renders. Setting the viewport does
not restrict where the Camera can scroll to.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#width">Phaser.Cameras.Scene2D.BaseCamera#width</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L1660">Line 1660</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="worldView">
    <h4 id="worldView"><span class="type-signature">&lt;readonly> </span>worldView<span class="type-signature"> :<a href="Phaser.Geom.Rectangle.html">Phaser.Geom.Rectangle</a></span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>The World View is a Rectangle that defines the area of the 'world' the Camera is currently looking at.
This factors in the Camera viewport size, zoom and scroll position and is updated in the Camera preRender step.
If you have enabled Camera bounds the worldview will be clamped to those bounds accordingly.
You can use it for culling or intersection checks.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Geom.Rectangle.html">Phaser.Geom.Rectangle</a></span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.11.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#worldView">Phaser.Cameras.Scene2D.BaseCamera#worldView</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L183">Line 183</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="zoom">
    <h4 id="zoom"><span class="type-signature"></span>zoom<span class="type-signature"> :number</span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>The Camera zoom value. Change this value to zoom in, or out of, a Scene.</p>
<p>A value of 0.5 would zoom the Camera out, so you can now see twice as much
of the Scene as before. A value of 2 would zoom the Camera in, so every pixel
now takes up 2 pixels when rendered.</p>
<p>Set to 1 to return to the default zoom level.</p>
<p>Be careful to never set this value to zero.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type">number</span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#zoom">Phaser.Cameras.Scene2D.BaseCamera#zoom</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	
	<dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
	<dd class="tag-default">
		<ul class="dummy">
			<li>1</li>
		</ul>
	</dd>
	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L1772">Line 1772</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        
            
<hr>
<dt class="name" id="zoomEffect">
    <h4 id="zoomEffect"><span class="type-signature"></span>zoomEffect<span class="type-signature"> :<a href="Phaser.Cameras.Scene2D.Effects.Zoom.html">Phaser.Cameras.Scene2D.Effects.Zoom</a></span></h4>

    
</dt>
<dd>
    
    <div class="description">
        <p>The Camera Zoom effect handler.
To zoom this camera see the <code>Camera.zoom</code> method.</p>
    </div>
    

    
        <h5>Type:</h5>
        <ul>
            <li>
                
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Effects.Zoom.html">Phaser.Cameras.Scene2D.Effects.Zoom</a></span>



            </li>
        </ul>
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.11.0</dt>
	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js">src/cameras/2d/Camera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js#L130">Line 130</a>)</dt>
	

	

	

	
</dl>


    
</dd>

        </dl>
    

    
        <h3 class="subsection-title">Methods</h3>

        <dl>
            
<hr>
<dt>
    <h4 class="name" id="addListener"><span class="type-signature"></span>addListener(event, fn [, context])</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Add a listener for a given event.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>event</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>
|

<span class="param-type">symbol</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>The event name.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>fn</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>The listener function.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>context</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    this
                
                </td>
            

            <td class="description last"><p>The context to invoke the listener with.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Events.EventEmitter.html#addListener">Phaser.Events.EventEmitter#addListener</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/events/EventEmitter.js">src/events/EventEmitter.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/events/EventEmitter.js#L111">Line 111</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p><code>this</code>.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="centerOn"><span class="type-signature"></span>centerOn(x, y)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Moves the Camera so that it is centered on the given coordinates, bounds allowing.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>x</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>



            
            </td>

            

            

            <td class="description last"><p>The horizontal coordinate to center on.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>y</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>



            
            </td>

            

            

            <td class="description last"><p>The vertical coordinate to center on.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.11.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#centerOn">Phaser.Cameras.Scene2D.BaseCamera#centerOn</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L657">Line 657</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This Camera instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="centerOnX"><span class="type-signature"></span>centerOnX(x)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Moves the Camera horizontally so that it is centered on the given x coordinate, bounds allowing.
Calling this does not change the scrollY value.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>x</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>



            
            </td>

            

            

            <td class="description last"><p>The horizontal coordinate to center on.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.16.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#centerOnX">Phaser.Cameras.Scene2D.BaseCamera#centerOnX</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L603">Line 603</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This Camera instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="centerOnY"><span class="type-signature"></span>centerOnY(y)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Moves the Camera vertically so that it is centered on the given y coordinate, bounds allowing.
Calling this does not change the scrollX value.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>y</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>



            
            </td>

            

            

            <td class="description last"><p>The vertical coordinate to center on.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.16.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#centerOnY">Phaser.Cameras.Scene2D.BaseCamera#centerOnY</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L630">Line 630</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This Camera instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="centerToBounds"><span class="type-signature"></span>centerToBounds()</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Moves the Camera so that it is looking at the center of the Camera Bounds, if enabled.</p>
    </div>
    

    

    

    
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#centerToBounds">Phaser.Cameras.Scene2D.BaseCamera#centerToBounds</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L676">Line 676</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This Camera instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="centerToSize"><span class="type-signature"></span>centerToSize()</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Moves the Camera so that it is re-centered based on its viewport size.</p>
    </div>
    

    

    

    
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#centerToSize">Phaser.Cameras.Scene2D.BaseCamera#centerToSize</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L701">Line 701</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This Camera instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="clampX"><span class="type-signature"></span>clampX(x)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Takes an x value and checks it's within the range of the Camera bounds, adjusting if required.
Do not call this method if you are not using camera bounds.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>x</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>



            
            </td>

            

            

            <td class="description last"><p>The value to horizontally scroll clamp.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.11.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#clampX">Phaser.Cameras.Scene2D.BaseCamera#clampX</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L970">Line 970</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>The adjusted value to use as scrollX.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">number</span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="clampY"><span class="type-signature"></span>clampY(y)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Takes a y value and checks it's within the range of the Camera bounds, adjusting if required.
Do not call this method if you are not using camera bounds.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>y</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>



            
            </td>

            

            

            <td class="description last"><p>The value to vertically scroll clamp.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.11.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#clampY">Phaser.Cameras.Scene2D.BaseCamera#clampY</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L1002">Line 1002</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>The adjusted value to use as scrollY.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">number</span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="clearAlpha"><span class="type-signature"></span>clearAlpha()</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Clears all alpha values associated with this Game Object.</p>
<p>Immediately sets the alpha levels back to 1 (fully opaque).</p>
    </div>
    

    

    

    
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.GameObjects.Components.Alpha.html#clearAlpha">Phaser.GameObjects.Components.Alpha#clearAlpha</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/gameobjects/components/Alpha.js">src/gameobjects/components/Alpha.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/gameobjects/components/Alpha.js#L77">Line 77</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This Game Object instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="clearMask"><span class="type-signature"></span>clearMask( [destroyMask])</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Clears the mask that this Camera was using.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>destroyMask</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    false
                
                </td>
            

            <td class="description last"><p>Destroy the mask before clearing it?</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.17.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#clearMask">Phaser.Cameras.Scene2D.BaseCamera#clearMask</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L1451">Line 1451</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This Camera instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="clearRenderToTexture"><span class="type-signature"></span>clearRenderToTexture()</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>If this Camera was set to render to a texture, this will clear the resources it was using and
redirect it to render back to the primary Canvas again.</p>
<p>If you only wish to temporarily disable rendering to a texture then you can toggle the
property <code>renderToTexture</code> instead.</p>
    </div>
    

    

    

    
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.13.0</dt>
	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js">src/cameras/2d/Camera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js#L413">Line 413</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This Camera instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="clearTint"><span class="type-signature"></span>clearTint()</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Clears all tint values associated with this Game Object.</p>
<p>Immediately sets the color values back to 0xffffff and the tint type to 'additive',
which results in no visible change to the texture.</p>
    </div>
    

    

    

    
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.GameObjects.Components.Tint.html#clearTint">Phaser.GameObjects.Components.Tint#clearTint</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/gameobjects/components/Tint.js">src/gameobjects/components/Tint.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/gameobjects/components/Tint.js#L93">Line 93</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This Game Object instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="cull"><span class="type-signature"></span>cull(renderableObjects)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Takes an array of Game Objects and returns a new array featuring only those objects
visible by this camera.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>renderableObjects</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;<a href="Phaser.GameObjects.GameObject.html">Phaser.GameObjects.GameObject</a>></span>



            
            </td>

            

            

            <td class="description last"><p>An array of Game Objects to cull.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#cull">Phaser.Cameras.Scene2D.BaseCamera#cull</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L717">Line 717</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>An array of Game Objects visible to this Camera.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Array.&lt;<a href="Phaser.GameObjects.GameObject.html">Phaser.GameObjects.GameObject</a>></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="destroy"><span class="type-signature"></span>destroy()</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Destroys this Camera instance. You rarely need to call this directly.</p>
<p>Called by the Camera Manager. If you wish to destroy a Camera please use <code>CameraManager.remove</code> as
cameras are stored in a pool, ready for recycling later, and calling this directly will prevent that.</p>
    </div>
    

    

    

    
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	

    
    <dt class="tag-overrides">Overrides:</dt>
    <dd class="tag-overrides"><ul class="dummy"><li>
        <a href="Phaser.Cameras.Scene2D.BaseCamera.html#destroy">Phaser.Cameras.Scene2D.BaseCamera#destroy</a>
    </li></ul></dd>
    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js">src/cameras/2d/Camera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js#L1023">Line 1023</a>)</dt>
	

	

	

	
</dl>


    

    
    <h5>Fires:</h5>
    <ul>
        <li><a href="Phaser.Cameras.Scene2D.Events.html#event:DESTROY">Phaser.Cameras.Scene2D.Events#event:DESTROY</a></li>
    </ul>
    

    

    

    

    

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="emit"><span class="type-signature"></span>emit(event [, args])</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Calls each of the listeners registered for a given event.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>event</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>
|

<span class="param-type">symbol</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            

            <td class="description last"><p>The event name.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>args</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                    &lt;repeatable><br>
                
                </td>
            

            

            <td class="description last"><p>Additional arguments that will be passed to the event handler.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Events.EventEmitter.html#emit">Phaser.Events.EventEmitter#emit</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/events/EventEmitter.js">src/events/EventEmitter.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/events/EventEmitter.js#L86">Line 86</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p><code>true</code> if the event had listeners, else <code>false</code>.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">boolean</span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="eventNames"><span class="type-signature"></span>eventNames()</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Return an array listing the events for which the emitter has registered listeners.</p>
    </div>
    

    

    

    
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Events.EventEmitter.html#eventNames">Phaser.Events.EventEmitter#eventNames</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/events/EventEmitter.js">src/events/EventEmitter.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/events/EventEmitter.js#L55">Line 55</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Array.&lt;(string|symbol)></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="fade"><span class="type-signature"></span>fade( [duration] [, red] [, green] [, blue] [, force] [, callback] [, context])</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Fades the Camera from transparent to the given color over the duration specified.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>duration</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    1000
                
                </td>
            

            <td class="description last"><p>The duration of the effect in milliseconds.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>red</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    0
                
                </td>
            

            <td class="description last"><p>The amount to fade the red channel towards. A value between 0 and 255.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>green</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    0
                
                </td>
            

            <td class="description last"><p>The amount to fade the green channel towards. A value between 0 and 255.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>blue</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    0
                
                </td>
            

            <td class="description last"><p>The amount to fade the blue channel towards. A value between 0 and 255.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>force</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    false
                
                </td>
            

            <td class="description last"><p>Force the effect to start immediately, even if already running.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>callback</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>This callback will be invoked every frame for the duration of the effect.
It is sent two arguments: A reference to the camera and a progress amount between 0 and 1 indicating how complete the effect is.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>context</code></td>
            

            <td class="type">
            
                
<span class="param-type">any</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js">src/cameras/2d/Camera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js#L601">Line 601</a>)</dt>
	

	

	

	
</dl>


    

    
    <h5>Fires:</h5>
    <ul>
        <li><a href="Phaser.Cameras.Scene2D.Events.html#event:FADE_OUT_START">Phaser.Cameras.Scene2D.Events#event:FADE_OUT_START</a></li>
    
        <li><a href="Phaser.Cameras.Scene2D.Events.html#event:FADE_OUT_COMPLETE">Phaser.Cameras.Scene2D.Events#event:FADE_OUT_COMPLETE</a></li>
    </ul>
    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This Camera instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="fadeFrom"><span class="type-signature"></span>fadeFrom( [duration] [, red] [, green] [, blue] [, force] [, callback] [, context])</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Fades the Camera from the given color to transparent over the duration specified.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>duration</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    1000
                
                </td>
            

            <td class="description last"><p>The duration of the effect in milliseconds.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>red</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    0
                
                </td>
            

            <td class="description last"><p>The amount to fade the red channel towards. A value between 0 and 255.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>green</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    0
                
                </td>
            

            <td class="description last"><p>The amount to fade the green channel towards. A value between 0 and 255.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>blue</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    0
                
                </td>
            

            <td class="description last"><p>The amount to fade the blue channel towards. A value between 0 and 255.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>force</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    false
                
                </td>
            

            <td class="description last"><p>Force the effect to start immediately, even if already running.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>callback</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>This callback will be invoked every frame for the duration of the effect.
It is sent two arguments: A reference to the camera and a progress amount between 0 and 1 indicating how complete the effect is.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>context</code></td>
            

            <td class="type">
            
                
<span class="param-type">any</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.5.0</dt>
	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js">src/cameras/2d/Camera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js#L577">Line 577</a>)</dt>
	

	

	

	
</dl>


    

    
    <h5>Fires:</h5>
    <ul>
        <li><a href="Phaser.Cameras.Scene2D.Events.html#event:FADE_IN_START">Phaser.Cameras.Scene2D.Events#event:FADE_IN_START</a></li>
    
        <li><a href="Phaser.Cameras.Scene2D.Events.html#event:FADE_IN_COMPLETE">Phaser.Cameras.Scene2D.Events#event:FADE_IN_COMPLETE</a></li>
    </ul>
    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This Camera instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="fadeIn"><span class="type-signature"></span>fadeIn( [duration] [, red] [, green] [, blue] [, callback] [, context])</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Fades the Camera in from the given color over the duration specified.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>duration</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    1000
                
                </td>
            

            <td class="description last"><p>The duration of the effect in milliseconds.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>red</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    0
                
                </td>
            

            <td class="description last"><p>The amount to fade the red channel towards. A value between 0 and 255.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>green</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    0
                
                </td>
            

            <td class="description last"><p>The amount to fade the green channel towards. A value between 0 and 255.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>blue</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    0
                
                </td>
            

            <td class="description last"><p>The amount to fade the blue channel towards. A value between 0 and 255.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>callback</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>This callback will be invoked every frame for the duration of the effect.
It is sent two arguments: A reference to the camera and a progress amount between 0 and 1 indicating how complete the effect is.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>context</code></td>
            

            <td class="type">
            
                
<span class="param-type">any</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.3.0</dt>
	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js">src/cameras/2d/Camera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js#L530">Line 530</a>)</dt>
	

	

	

	
</dl>


    

    
    <h5>Fires:</h5>
    <ul>
        <li><a href="Phaser.Cameras.Scene2D.Events.html#event:FADE_IN_START">Phaser.Cameras.Scene2D.Events#event:FADE_IN_START</a></li>
    
        <li><a href="Phaser.Cameras.Scene2D.Events.html#event:FADE_IN_COMPLETE">Phaser.Cameras.Scene2D.Events#event:FADE_IN_COMPLETE</a></li>
    </ul>
    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This Camera instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="fadeOut"><span class="type-signature"></span>fadeOut( [duration] [, red] [, green] [, blue] [, callback] [, context])</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Fades the Camera out to the given color over the duration specified.
This is an alias for Camera.fade that forces the fade to start, regardless of existing fades.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>duration</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    1000
                
                </td>
            

            <td class="description last"><p>The duration of the effect in milliseconds.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>red</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    0
                
                </td>
            

            <td class="description last"><p>The amount to fade the red channel towards. A value between 0 and 255.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>green</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    0
                
                </td>
            

            <td class="description last"><p>The amount to fade the green channel towards. A value between 0 and 255.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>blue</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    0
                
                </td>
            

            <td class="description last"><p>The amount to fade the blue channel towards. A value between 0 and 255.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>callback</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>This callback will be invoked every frame for the duration of the effect.
It is sent two arguments: A reference to the camera and a progress amount between 0 and 1 indicating how complete the effect is.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>context</code></td>
            

            <td class="type">
            
                
<span class="param-type">any</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.3.0</dt>
	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js">src/cameras/2d/Camera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js#L553">Line 553</a>)</dt>
	

	

	

	
</dl>


    

    
    <h5>Fires:</h5>
    <ul>
        <li><a href="Phaser.Cameras.Scene2D.Events.html#event:FADE_OUT_START">Phaser.Cameras.Scene2D.Events#event:FADE_OUT_START</a></li>
    
        <li><a href="Phaser.Cameras.Scene2D.Events.html#event:FADE_OUT_COMPLETE">Phaser.Cameras.Scene2D.Events#event:FADE_OUT_COMPLETE</a></li>
    </ul>
    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This Camera instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="flash"><span class="type-signature"></span>flash( [duration] [, red] [, green] [, blue] [, force] [, callback] [, context])</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Flashes the Camera by setting it to the given color immediately and then fading it away again quickly over the duration specified.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>duration</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    250
                
                </td>
            

            <td class="description last"><p>The duration of the effect in milliseconds.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>red</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    255
                
                </td>
            

            <td class="description last"><p>The amount to fade the red channel towards. A value between 0 and 255.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>green</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    255
                
                </td>
            

            <td class="description last"><p>The amount to fade the green channel towards. A value between 0 and 255.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>blue</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    255
                
                </td>
            

            <td class="description last"><p>The amount to fade the blue channel towards. A value between 0 and 255.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>force</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    false
                
                </td>
            

            <td class="description last"><p>Force the effect to start immediately, even if already running.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>callback</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>This callback will be invoked every frame for the duration of the effect.
It is sent two arguments: A reference to the camera and a progress amount between 0 and 1 indicating how complete the effect is.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>context</code></td>
            

            <td class="type">
            
                
<span class="param-type">any</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js">src/cameras/2d/Camera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js#L625">Line 625</a>)</dt>
	

	

	

	
</dl>


    

    
    <h5>Fires:</h5>
    <ul>
        <li><a href="Phaser.Cameras.Scene2D.Events.html#event:FLASH_START">Phaser.Cameras.Scene2D.Events#event:FLASH_START</a></li>
    
        <li><a href="Phaser.Cameras.Scene2D.Events.html#event:FLASH_COMPLETE">Phaser.Cameras.Scene2D.Events#event:FLASH_COMPLETE</a></li>
    </ul>
    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This Camera instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="getBounds"><span class="type-signature"></span>getBounds( [out])</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Returns a rectangle containing the bounds of the Camera.</p>
<p>If the Camera does not have any bounds the rectangle will be empty.</p>
<p>The rectangle is a copy of the bounds, so is safe to modify.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>out</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Phaser.Geom.Rectangle.html">Phaser.Geom.Rectangle</a></span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description last"><p>An optional Rectangle to store the bounds in. If not given, a new Rectangle will be created.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.16.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#getBounds">Phaser.Cameras.Scene2D.BaseCamera#getBounds</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L1157">Line 1157</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>A rectangle containing the bounds of this Camera.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Geom.Rectangle.html">Phaser.Geom.Rectangle</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="getScroll"><span class="type-signature"></span>getScroll(x, y [, out])</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Calculates what the Camera.scrollX and scrollY values would need to be in order to move
the Camera so it is centered on the given x and y coordinates, without actually moving
the Camera there. The results are clamped based on the Camera bounds, if set.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>x</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            

            <td class="description last"><p>The horizontal coordinate to center on.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>y</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            

            <td class="description last"><p>The vertical coordinate to center on.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>out</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Phaser.Math.Vector2.html">Phaser.Math.Vector2</a></span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description last"><p>A Vector2 to store the values in. If not given a new Vector2 is created.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.11.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#getScroll">Phaser.Cameras.Scene2D.BaseCamera#getScroll</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L570">Line 570</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>The scroll coordinates stored in the <code>x</code> and <code>y</code> properties.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Math.Vector2.html">Phaser.Math.Vector2</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="getWorldPoint"><span class="type-signature"></span>getWorldPoint(x, y [, output])</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Converts the given <code>x</code> and <code>y</code> coordinates into World space, based on this Cameras transform.
You can optionally provide a Vector2, or similar object, to store the results in.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>x</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            

            <td class="description last"><p>The x position to convert to world space.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>y</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            

            <td class="description last"><p>The y position to convert to world space.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>output</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>
|

<span class="param-type"><a href="Phaser.Math.Vector2.html">Phaser.Math.Vector2</a></span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description last"><p>An optional object to store the results in. If not provided a new Vector2 will be created.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#getWorldPoint">Phaser.Cameras.Scene2D.BaseCamera#getWorldPoint</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L798">Line 798</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>An object holding the converted values in its <code>x</code> and <code>y</code> properties.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Math.Vector2.html">Phaser.Math.Vector2</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="ignore"><span class="type-signature"></span>ignore(entries)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Given a Game Object, or an array of Game Objects, it will update all of their camera filter settings
so that they are ignored by this Camera. This means they will not be rendered by this Camera.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>entries</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Phaser.GameObjects.GameObject.html">Phaser.GameObjects.GameObject</a></span>
|

<span class="param-type">Array.&lt;<a href="Phaser.GameObjects.GameObject.html">Phaser.GameObjects.GameObject</a>></span>
|

<span class="param-type"><a href="Phaser.GameObjects.Group.html">Phaser.GameObjects.Group</a></span>



            
            </td>

            

            

            <td class="description last"><p>The Game Object, or array of Game Objects, to be ignored by this Camera.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#ignore">Phaser.Cameras.Scene2D.BaseCamera#ignore</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L866">Line 866</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This Camera instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="listenerCount"><span class="type-signature"></span>listenerCount(event)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Return the number of listeners listening to a given event.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>event</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>
|

<span class="param-type">symbol</span>



            
            </td>

            

            

            <td class="description last"><p>The event name.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Events.EventEmitter.html#listenerCount">Phaser.Events.EventEmitter#listenerCount</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/events/EventEmitter.js">src/events/EventEmitter.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/events/EventEmitter.js#L75">Line 75</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>The number of listeners.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">number</span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="listeners"><span class="type-signature"></span>listeners(event)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Return the listeners registered for a given event.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>event</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>
|

<span class="param-type">symbol</span>



            
            </td>

            

            

            <td class="description last"><p>The event name.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Events.EventEmitter.html#listeners">Phaser.Events.EventEmitter#listeners</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/events/EventEmitter.js">src/events/EventEmitter.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/events/EventEmitter.js#L64">Line 64</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>The registered listeners.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Array.&lt;function()></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="off"><span class="type-signature"></span>off(event [, fn] [, context] [, once])</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Remove the listeners of a given event.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>event</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>
|

<span class="param-type">symbol</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            

            <td class="description last"><p>The event name.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>fn</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description last"><p>Only remove the listeners that match this function.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>context</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description last"><p>Only remove the listeners that have this context.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>once</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description last"><p>Only remove one-time listeners.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Events.EventEmitter.html#off">Phaser.Events.EventEmitter#off</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/events/EventEmitter.js">src/events/EventEmitter.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/events/EventEmitter.js#L151">Line 151</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p><code>this</code>.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="on"><span class="type-signature"></span>on(event, fn [, context])</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Add a listener for a given event.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>event</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>
|

<span class="param-type">symbol</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>The event name.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>fn</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>The listener function.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>context</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    this
                
                </td>
            

            <td class="description last"><p>The context to invoke the listener with.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Events.EventEmitter.html#on">Phaser.Events.EventEmitter#on</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/events/EventEmitter.js">src/events/EventEmitter.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/events/EventEmitter.js#L98">Line 98</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p><code>this</code>.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="once"><span class="type-signature"></span>once(event, fn [, context])</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Add a one-time listener for a given event.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>event</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>
|

<span class="param-type">symbol</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>The event name.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>fn</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>The listener function.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>context</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    this
                
                </td>
            

            <td class="description last"><p>The context to invoke the listener with.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Events.EventEmitter.html#once">Phaser.Events.EventEmitter#once</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/events/EventEmitter.js">src/events/EventEmitter.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/events/EventEmitter.js#L124">Line 124</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p><code>this</code>.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="pan"><span class="type-signature"></span>pan(x, y [, duration] [, ease] [, force] [, callback] [, context])</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>This effect will scroll the Camera so that the center of its viewport finishes at the given destination,
over the duration and with the ease specified.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>x</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>The destination x coordinate to scroll the center of the Camera viewport to.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>y</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>The destination y coordinate to scroll the center of the Camera viewport to.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>duration</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    1000
                
                </td>
            

            <td class="description last"><p>The duration of the effect in milliseconds.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>ease</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>
|

<span class="param-type">function</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    'Linear'
                
                </td>
            

            <td class="description last"><p>The ease to use for the pan. Can be any of the Phaser Easing constants or a custom function.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>force</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    false
                
                </td>
            

            <td class="description last"><p>Force the pan effect to start immediately, even if already running.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>callback</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Phaser.Types.Cameras.Scene2D.html#.CameraPanCallback">Phaser.Types.Cameras.Scene2D.CameraPanCallback</a></span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>This callback will be invoked every frame for the duration of the effect.
It is sent four arguments: A reference to the camera, a progress amount between 0 and 1 indicating how complete the effect is,
the current camera scroll x coordinate and the current camera scroll y coordinate.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>context</code></td>
            

            <td class="type">
            
                
<span class="param-type">any</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.11.0</dt>
	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js">src/cameras/2d/Camera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js#L671">Line 671</a>)</dt>
	

	

	

	
</dl>


    

    
    <h5>Fires:</h5>
    <ul>
        <li><a href="Phaser.Cameras.Scene2D.Events.html#event:PAN_START">Phaser.Cameras.Scene2D.Events#event:PAN_START</a></li>
    
        <li><a href="Phaser.Cameras.Scene2D.Events.html#event:PAN_COMPLETE">Phaser.Cameras.Scene2D.Events#event:PAN_COMPLETE</a></li>
    </ul>
    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This Camera instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="preRender"><span class="type-signature">&lt;protected> </span>preRender(resolution)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Internal preRender step.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>resolution</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>



            
            </td>

            

            

            <td class="description last"><p>The game resolution, as set in the Scale Manager.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	

    
    <dt class="tag-overrides">Overrides:</dt>
    <dd class="tag-overrides"><ul class="dummy"><li>
        <a href="Phaser.Cameras.Scene2D.BaseCamera.html#preRender">Phaser.Cameras.Scene2D.BaseCamera#preRender</a>
    </li></ul></dd>
    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js">src/cameras/2d/Camera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js#L745">Line 745</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="removeAllListeners"><span class="type-signature"></span>removeAllListeners( [event])</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Remove all listeners, or those of the specified event.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>event</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>
|

<span class="param-type">symbol</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description last"><p>The event name.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Events.EventEmitter.html#removeAllListeners">Phaser.Events.EventEmitter#removeAllListeners</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/events/EventEmitter.js">src/events/EventEmitter.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/events/EventEmitter.js#L165">Line 165</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p><code>this</code>.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="removeBounds"><span class="type-signature"></span>removeBounds()</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>If this Camera has previously had movement bounds set on it, this will remove them.</p>
    </div>
    

    

    

    
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#removeBounds">Phaser.Cameras.Scene2D.BaseCamera#removeBounds</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L1039">Line 1039</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This Camera instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="removeListener"><span class="type-signature"></span>removeListener(event [, fn] [, context] [, once])</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Remove the listeners of a given event.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>event</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>
|

<span class="param-type">symbol</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            

            <td class="description last"><p>The event name.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>fn</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description last"><p>Only remove the listeners that match this function.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>context</code></td>
            

            <td class="type">
            
                
<span class="param-type">*</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description last"><p>Only remove the listeners that have this context.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>once</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description last"><p>Only remove one-time listeners.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Events.EventEmitter.html#removeListener">Phaser.Events.EventEmitter#removeListener</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/events/EventEmitter.js">src/events/EventEmitter.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/events/EventEmitter.js#L137">Line 137</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p><code>this</code>.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="resetFlip"><span class="type-signature"></span>resetFlip()</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Resets the horizontal and vertical flipped state of this Game Object back to their default un-flipped state.</p>
    </div>
    

    

    

    
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.GameObjects.Components.Flip.html#resetFlip">Phaser.GameObjects.Components.Flip#resetFlip</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/gameobjects/components/Flip.js">src/gameobjects/components/Flip.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/gameobjects/components/Flip.js#L140">Line 140</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This Game Object instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="resetFX"><span class="type-signature"></span>resetFX()</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Resets any active FX, such as a fade, flash or shake. Useful to call after a fade in order to
remove the fade.</p>
    </div>
    

    

    

    
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js">src/cameras/2d/Camera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js#L980">Line 980</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This Camera instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="rotateTo"><span class="type-signature"></span>rotateTo(radians [, shortestPath] [, duration] [, ease] [, force] [, callback] [, context])</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>This effect will rotate the Camera so that the viewport finishes at the given angle in radians,
over the duration and with the ease specified.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>radians</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>The destination angle in radians to rotate the Camera viewport to. If the angle is positive then the rotation is clockwise else anticlockwise</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>shortestPath</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    false
                
                </td>
            

            <td class="description last"><p>If shortest path is set to true the camera will rotate in the quickest direction clockwise or anti-clockwise.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>duration</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    1000
                
                </td>
            

            <td class="description last"><p>The duration of the effect in milliseconds.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>ease</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>
|

<span class="param-type">function</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    'Linear'
                
                </td>
            

            <td class="description last"><p>The ease to use for the rotation. Can be any of the Phaser Easing constants or a custom function.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>force</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    false
                
                </td>
            

            <td class="description last"><p>Force the rotation effect to start immediately, even if already running.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>callback</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="global.html#CameraRotateCallback">CameraRotateCallback</a></span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>This callback will be invoked every frame for the duration of the effect.
It is sent four arguments: A reference to the camera, a progress amount between 0 and 1 indicating how complete the effect is,
the current camera rotation angle in radians.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>context</code></td>
            

            <td class="type">
            
                
<span class="param-type">any</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.23.0</dt>
	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js">src/cameras/2d/Camera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js#L697">Line 697</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This Camera instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="setAlpha"><span class="type-signature"></span>setAlpha( [value])</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Set the Alpha level of this Camera. The alpha controls the opacity of the Camera as it renders.
Alpha values are provided as a float between 0, fully transparent, and 1, fully opaque.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>value</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    1
                
                </td>
            

            <td class="description last"><p>The Camera alpha value.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.11.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#setAlpha">Phaser.Cameras.Scene2D.BaseCamera#setAlpha</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L529">Line 529</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This Camera instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="setAngle"><span class="type-signature"></span>setAngle( [value])</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Set the rotation of this Camera. This causes everything it renders to appear rotated.</p>
<p>Rotating a camera does not rotate the viewport itself, it is applied during rendering.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>value</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    0
                
                </td>
            

            <td class="description last"><p>The cameras angle of rotation, given in degrees.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#setAngle">Phaser.Cameras.Scene2D.BaseCamera#setAngle</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L1058">Line 1058</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This Camera instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="setBackgroundColor"><span class="type-signature"></span>setBackgroundColor( [color])</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Sets the background color for this Camera.</p>
<p>By default a Camera has a transparent background but it can be given a solid color, with any level
of transparency, via this method.</p>
<p>The color value can be specified using CSS color notation, hex or numbers.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>color</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>
|

<span class="param-type">number</span>
|

<span class="param-type"><a href="Phaser.Types.Display.html#.InputColorObject">Phaser.Types.Display.InputColorObject</a></span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    'rgba(0,0,0,0)'
                
                </td>
            

            <td class="description last"><p>The color value. In CSS, hex or numeric color notation.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#setBackgroundColor">Phaser.Cameras.Scene2D.BaseCamera#setBackgroundColor</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L1079">Line 1079</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This Camera instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="setBounds"><span class="type-signature"></span>setBounds(x, y, width, height [, centerOn])</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Set the bounds of the Camera. The bounds are an axis-aligned rectangle.</p>
<p>The Camera bounds controls where the Camera can scroll to, stopping it from scrolling off the
edges and into blank space. It does not limit the placement of Game Objects, or where
the Camera viewport can be positioned.</p>
<p>Temporarily disable the bounds by changing the boolean <code>Camera.useBounds</code>.</p>
<p>Clear the bounds entirely by calling <code>Camera.removeBounds</code>.</p>
<p>If you set bounds that are smaller than the viewport it will stop the Camera from being
able to scroll. The bounds can be positioned where-ever you wish. By default they are from
0x0 to the canvas width x height. This means that the coordinate 0x0 is the top left of
the Camera bounds. However, you can position them anywhere. So if you wanted a game world
that was 2048x2048 in size, with 0x0 being the center of it, you can set the bounds x/y
to be -1024, -1024, with a width and height of 2048. Depending on your game you may find
it easier for 0x0 to be the top-left of the bounds, or you may wish 0x0 to be the middle.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>x</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>The top-left x coordinate of the bounds.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>y</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>The top-left y coordinate of the bounds.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>width</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>The width of the bounds, in pixels.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>height</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>The height of the bounds, in pixels.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>centerOn</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    false
                
                </td>
            

            <td class="description last"><p>If <code>true</code> the Camera will automatically be centered on the new bounds.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#setBounds">Phaser.Cameras.Scene2D.BaseCamera#setBounds</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L1105">Line 1105</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This Camera instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="setDeadzone"><span class="type-signature"></span>setDeadzone( [width] [, height])</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Sets the Camera dead zone.</p>
<p>The deadzone is only used when the camera is following a target.</p>
<p>It defines a rectangular region within which if the target is present, the camera will not scroll.
If the target moves outside of this area, the camera will begin scrolling in order to follow it.</p>
<p>The deadzone rectangle is re-positioned every frame so that it is centered on the mid-point
of the camera. This allows you to use the object for additional game related checks, such as
testing if an object is within it or not via a Rectangle.contains call.</p>
<p>The <code>lerp</code> values that you can set for a follower target also apply when using a deadzone.</p>
<p>Calling this method with no arguments will reset an active deadzone.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>width</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description last"><p>The width of the deadzone rectangle in pixels. If not specified the deadzone is removed.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>height</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description last"><p>The height of the deadzone rectangle in pixels.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.11.0</dt>
	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js">src/cameras/2d/Camera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js#L468">Line 468</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This Camera instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="setFlip"><span class="type-signature"></span>setFlip(x, y)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Sets the horizontal and vertical flipped state of this Game Object.</p>
<p>A Game Object that is flipped will render inversed on the flipped axis.
Flipping always takes place from the middle of the texture and does not impact the scale value.
If this Game Object has a physics body, it will not change the body. This is a rendering toggle only.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>x</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>



            
            </td>

            

            

            <td class="description last"><p>The horizontal flipped state. <code>false</code> for no flip, or <code>true</code> to be flipped.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>y</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>



            
            </td>

            

            

            <td class="description last"><p>The horizontal flipped state. <code>false</code> for no flip, or <code>true</code> to be flipped.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.GameObjects.Components.Flip.html#setFlip">Phaser.GameObjects.Components.Flip#setFlip</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/gameobjects/components/Flip.js">src/gameobjects/components/Flip.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/gameobjects/components/Flip.js#L117">Line 117</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This Game Object instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="setFlipX"><span class="type-signature"></span>setFlipX(value)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Sets the horizontal flipped state of this Game Object.</p>
<p>A Game Object that is flipped horizontally will render inversed on the horizontal axis.
Flipping always takes place from the middle of the texture and does not impact the scale value.
If this Game Object has a physics body, it will not change the body. This is a rendering toggle only.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>value</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>



            
            </td>

            

            

            <td class="description last"><p>The flipped state. <code>false</code> for no flip, or <code>true</code> to be flipped.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.GameObjects.Components.Flip.html#setFlipX">Phaser.GameObjects.Components.Flip#setFlipX</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/gameobjects/components/Flip.js">src/gameobjects/components/Flip.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/gameobjects/components/Flip.js#L79">Line 79</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This Game Object instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="setFlipY"><span class="type-signature"></span>setFlipY(value)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Sets the vertical flipped state of this Game Object.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>value</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>



            
            </td>

            

            

            <td class="description last"><p>The flipped state. <code>false</code> for no flip, or <code>true</code> to be flipped.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.GameObjects.Components.Flip.html#setFlipY">Phaser.GameObjects.Components.Flip#setFlipY</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/gameobjects/components/Flip.js">src/gameobjects/components/Flip.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/gameobjects/components/Flip.js#L100">Line 100</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This Game Object instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="setFollowOffset"><span class="type-signature"></span>setFollowOffset( [x] [, y])</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Sets the horizontal and vertical offset of the camera from its follow target.
The values are subtracted from the targets position during the Cameras update step.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>x</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    0
                
                </td>
            

            <td class="description last"><p>The horizontal offset from the camera follow target.x position.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>y</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    0
                
                </td>
            

            <td class="description last"><p>The vertical offset from the camera follow target.y position.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.9.0</dt>
	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js">src/cameras/2d/Camera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js#L878">Line 878</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This Camera instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="setLerp"><span class="type-signature"></span>setLerp( [x] [, y])</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Sets the linear interpolation value to use when following a target.</p>
<p>The default values of 1 means the camera will instantly snap to the target coordinates.
A lower value, such as 0.1 means the camera will more slowly track the target, giving
a smooth transition. You can set the horizontal and vertical values independently, and also
adjust this value in real-time during your game.</p>
<p>Be sure to keep the value between 0 and 1. A value of zero will disable tracking on that axis.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>x</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    1
                
                </td>
            

            <td class="description last"><p>The amount added to the horizontal linear interpolation of the follow target.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>y</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    1
                
                </td>
            

            <td class="description last"><p>The amount added to the vertical linear interpolation of the follow target.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.9.0</dt>
	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js">src/cameras/2d/Camera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js#L850">Line 850</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This Camera instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="setMask"><span class="type-signature"></span>setMask(mask [, fixedPosition])</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Sets the mask to be applied to this Camera during rendering.</p>
<p>The mask must have been previously created and can be either a GeometryMask or a BitmapMask.</p>
<p>Bitmap Masks only work on WebGL. Geometry Masks work on both WebGL and Canvas.</p>
<p>If a mask is already set on this Camera it will be immediately replaced.</p>
<p>Masks have no impact on physics or input detection. They are purely a rendering component
that allows you to limit what is visible during the render pass.</p>
<p>Note: You cannot mask a Camera that has <code>renderToTexture</code> set.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>mask</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Phaser.Display.Masks.BitmapMask.html">Phaser.Display.Masks.BitmapMask</a></span>
|

<span class="param-type"><a href="Phaser.Display.Masks.GeometryMask.html">Phaser.Display.Masks.GeometryMask</a></span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>The mask this Camera will use when rendering.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>fixedPosition</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    true
                
                </td>
            

            <td class="description last"><p>Should the mask translate along with the Camera, or be fixed in place and not impacted by the Cameras transform?</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.17.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#setMask">Phaser.Cameras.Scene2D.BaseCamera#setMask</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L1418">Line 1418</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This Camera instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="setName"><span class="type-signature"></span>setName( [value])</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Sets the name of this Camera.
This value is for your own use and isn't used internally.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>value</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    ''
                
                </td>
            

            <td class="description last"><p>The name of the Camera.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#setName">Phaser.Cameras.Scene2D.BaseCamera#setName</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L1182">Line 1182</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This Camera instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="setOrigin"><span class="type-signature"></span>setOrigin( [x] [, y])</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Sets the rotation origin of this Camera.</p>
<p>The values are given in the range 0 to 1 and are only used when calculating Camera rotation.</p>
<p>By default the camera rotates around the center of the viewport.</p>
<p>Changing the origin allows you to adjust the point in the viewport from which rotation happens.
A value of 0 would rotate from the top-left of the viewport. A value of 1 from the bottom right.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>x</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    0.5
                
                </td>
            

            <td class="description last"><p>The horizontal origin value.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>y</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    x
                
                </td>
            

            <td class="description last"><p>The vertical origin value. If not defined it will be set to the value of <code>x</code>.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.11.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#setOrigin">Phaser.Cameras.Scene2D.BaseCamera#setOrigin</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L541">Line 541</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This Camera instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="setPipeline"><span class="type-signature"></span>setPipeline( [pipeline])</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Sets the WebGL pipeline this Camera is using when rendering to a texture.</p>
<p>You can pass either the string-based name of the pipeline, or a reference to the pipeline itself.</p>
<p>Call this method with no arguments to clear any previously set pipeline.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>pipeline</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>
|

<span class="param-type"><a href="Phaser.Renderer.WebGL.WebGLPipeline.html">Phaser.Renderer.WebGL.WebGLPipeline</a></span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            

            <td class="description last"><p>The WebGL Pipeline to render with, can be either a string which is the name of the pipeline, or a pipeline reference. Or if left empty it will clear the pipeline.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.13.0</dt>
	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js">src/cameras/2d/Camera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js#L380">Line 380</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This Camera instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="setPosition"><span class="type-signature"></span>setPosition(x [, y])</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Set the position of the Camera viewport within the game.</p>
<p>This does not change where the camera is 'looking'. See <code>setScroll</code> to control that.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>x</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>The top-left x coordinate of the Camera viewport.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>y</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    x
                
                </td>
            

            <td class="description last"><p>The top-left y coordinate of the Camera viewport.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#setPosition">Phaser.Cameras.Scene2D.BaseCamera#setPosition</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L1202">Line 1202</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This Camera instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="setRenderToTexture"><span class="type-signature"></span>setRenderToTexture( [pipeline] [, renderToGame])</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Sets the Camera to render to a texture instead of to the main canvas.</p>
<p>The Camera will redirect all Game Objects it's asked to render to this texture.</p>
<p>During the render sequence, the texture itself will then be rendered to the main canvas.</p>
<p>Doing this gives you the ability to modify the texture before this happens,
allowing for special effects such as Camera specific shaders, or post-processing
on the texture.</p>
<p>If running under Canvas the Camera will render to its <code>canvas</code> property.</p>
<p>If running under WebGL the Camera will create a frame buffer, which is stored in its <code>framebuffer</code> and <code>glTexture</code> properties.</p>
<p>If you set a camera to render to a texture then it will emit 2 events during the render loop:</p>
<p>First, it will emit the event <code>prerender</code>. This happens right before any Game Object's are drawn to the Camera texture.</p>
<p>Then, it will emit the event <code>postrender</code>. This happens after all Game Object's have been drawn, but right before the
Camera texture is rendered to the main game canvas. It's the final point at which you can manipulate the texture before
it appears in-game.</p>
<p>You should not enable this unless you plan on actually using the texture it creates
somehow, otherwise you're just doubling the work required to render your game.</p>
<p>If you only require the Camera to render to a texture, and not also to the Game,
them set the <code>renderToGame</code> parameter to <code>false</code>.</p>
<p>To temporarily disable rendering to a texture, toggle the <code>renderToTexture</code> boolean.</p>
<p>If you no longer require the Camera to render to a texture, call the <code>clearRenderToTexture</code> method,
which will delete the respective textures and free-up resources.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>pipeline</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>
|

<span class="param-type"><a href="Phaser.Renderer.WebGL.WebGLPipeline.html">Phaser.Renderer.WebGL.WebGLPipeline</a></span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>An optional WebGL Pipeline to render with, can be either a string which is the name of the pipeline, or a pipeline reference.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>renderToGame</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    true
                
                </td>
            

            <td class="description last"><p>If you do not need the Camera to still render to the Game, set this parameter to <code>false</code>.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.13.0</dt>
	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js">src/cameras/2d/Camera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js#L310">Line 310</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This Camera instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="setRotation"><span class="type-signature"></span>setRotation( [value])</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Set the rotation of this Camera. This causes everything it renders to appear rotated.</p>
<p>Rotating a camera does not rotate the viewport itself, it is applied during rendering.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>value</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    0
                
                </td>
            

            <td class="description last"><p>The rotation of the Camera, in radians.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#setRotation">Phaser.Cameras.Scene2D.BaseCamera#setRotation</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L1225">Line 1225</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This Camera instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="setRoundPixels"><span class="type-signature"></span>setRoundPixels(value)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Should the Camera round pixel values to whole integers when rendering Game Objects?</p>
<p>In some types of game, especially with pixel art, this is required to prevent sub-pixel aliasing.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>value</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>



            
            </td>

            

            

            <td class="description last"><p><code>true</code> to round Camera pixels, <code>false</code> to not.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#setRoundPixels">Phaser.Cameras.Scene2D.BaseCamera#setRoundPixels</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L1246">Line 1246</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This Camera instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="setScene"><span class="type-signature"></span>setScene(scene)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Sets the Scene the Camera is bound to.</p>
<p>Also populates the <code>resolution</code> property and updates the internal size values.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>scene</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Phaser.Scene.html">Phaser.Scene</a></span>



            
            </td>

            

            

            <td class="description last"><p>The Scene the camera is bound to.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#setScene">Phaser.Cameras.Scene2D.BaseCamera#setScene</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L1265">Line 1265</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This Camera instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="setScroll"><span class="type-signature"></span>setScroll(x [, y])</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Set the position of where the Camera is looking within the game.
You can also modify the properties <code>Camera.scrollX</code> and <code>Camera.scrollY</code> directly.
Use this method, or the scroll properties, to move your camera around the game world.</p>
<p>This does not change where the camera viewport is placed. See <code>setPosition</code> to control that.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>x</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>The x coordinate of the Camera in the game world.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>y</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    x
                
                </td>
            

            <td class="description last"><p>The y coordinate of the Camera in the game world.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#setScroll">Phaser.Cameras.Scene2D.BaseCamera#setScroll</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L1306">Line 1306</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This Camera instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="setSize"><span class="type-signature"></span>setSize(width [, height])</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Set the size of the Camera viewport.</p>
<p>By default a Camera is the same size as the game, but can be made smaller via this method,
allowing you to create mini-cam style effects by creating and positioning a smaller Camera
viewport within your game.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>width</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>The width of the Camera viewport.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>height</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    width
                
                </td>
            

            <td class="description last"><p>The height of the Camera viewport.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#setSize">Phaser.Cameras.Scene2D.BaseCamera#setSize</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L1331">Line 1331</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This Camera instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="setTint"><span class="type-signature"></span>setTint( [topLeft] [, topRight] [, bottomLeft] [, bottomRight])</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Sets an additive tint on this Game Object.</p>
<p>The tint works by taking the pixel color values from the Game Objects texture, and then
multiplying it by the color value of the tint. You can provide either one color value,
in which case the whole Game Object will be tinted in that color. Or you can provide a color
per corner. The colors are blended together across the extent of the Game Object.</p>
<p>To modify the tint color once set, either call this method again with new values or use the
<code>tint</code> property to set all colors at once. Or, use the properties <code>tintTopLeft</code>, <code>tintTopRight,</code>tintBottomLeft<code>and</code>tintBottomRight` to set the corner color values independently.</p>
<p>To remove a tint call <code>clearTint</code>.</p>
<p>To swap this from being an additive tint to a fill based tint set the property <code>tintFill</code> to <code>true</code>.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>topLeft</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    0xffffff
                
                </td>
            

            <td class="description last"><p>The tint being applied to the top-left of the Game Object. If no other values are given this value is applied evenly, tinting the whole Game Object.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>topRight</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>The tint being applied to the top-right of the Game Object.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>bottomLeft</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>The tint being applied to the bottom-left of the Game Object.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>bottomRight</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>The tint being applied to the bottom-right of the Game Object.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.GameObjects.Components.Tint.html#setTint">Phaser.GameObjects.Components.Tint#setTint</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/gameobjects/components/Tint.js">src/gameobjects/components/Tint.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/gameobjects/components/Tint.js#L114">Line 114</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This Game Object instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="setTintFill"><span class="type-signature"></span>setTintFill( [topLeft] [, topRight] [, bottomLeft] [, bottomRight])</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Sets a fill-based tint on this Game Object.</p>
<p>Unlike an additive tint, a fill-tint literally replaces the pixel colors from the texture
with those in the tint. You can use this for effects such as making a player flash 'white'
if hit by something. You can provide either one color value, in which case the whole
Game Object will be rendered in that color. Or you can provide a color per corner. The colors
are blended together across the extent of the Game Object.</p>
<p>To modify the tint color once set, either call this method again with new values or use the
<code>tint</code> property to set all colors at once. Or, use the properties <code>tintTopLeft</code>, <code>tintTopRight,</code>tintBottomLeft<code>and</code>tintBottomRight` to set the corner color values independently.</p>
<p>To remove a tint call <code>clearTint</code>.</p>
<p>To swap this from being a fill-tint to an additive tint set the property <code>tintFill</code> to <code>false</code>.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>topLeft</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    0xffffff
                
                </td>
            

            <td class="description last"><p>The tint being applied to the top-left of the Game Object. If not other values are given this value is applied evenly, tinting the whole Game Object.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>topRight</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>The tint being applied to the top-right of the Game Object.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>bottomLeft</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>The tint being applied to the bottom-left of the Game Object.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>bottomRight</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>The tint being applied to the bottom-right of the Game Object.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.11.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.GameObjects.Components.Tint.html#setTintFill">Phaser.GameObjects.Components.Tint#setTintFill</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/gameobjects/components/Tint.js">src/gameobjects/components/Tint.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/gameobjects/components/Tint.js#L164">Line 164</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This Game Object instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="setViewport"><span class="type-signature"></span>setViewport(x, y, width [, height])</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>This method sets the position and size of the Camera viewport in a single call.</p>
<p>If you're trying to change where the Camera is looking at in your game, then see
the method <code>Camera.setScroll</code> instead. This method is for changing the viewport
itself, not what the camera can see.</p>
<p>By default a Camera is the same size as the game, but can be made smaller via this method,
allowing you to create mini-cam style effects by creating and positioning a smaller Camera
viewport within your game.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>x</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>The top-left x coordinate of the Camera viewport.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>y</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>The top-left y coordinate of the Camera viewport.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>width</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>The width of the Camera viewport.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>height</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    width
                
                </td>
            

            <td class="description last"><p>The height of the Camera viewport.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#setViewport">Phaser.Cameras.Scene2D.BaseCamera#setViewport</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L1356">Line 1356</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This Camera instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="setVisible"><span class="type-signature"></span>setVisible(value)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Sets the visibility of this Camera.</p>
<p>An invisible Camera will skip rendering and input tests of everything it can see.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>value</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>



            
            </td>

            

            

            <td class="description last"><p>The visible state of the Camera.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.10.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#setVisible">Phaser.Cameras.Scene2D.BaseCamera#setVisible</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L1475">Line 1475</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This Camera instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="setZoom"><span class="type-signature"></span>setZoom( [value])</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Set the zoom value of the Camera.</p>
<p>Changing to a smaller value, such as 0.5, will cause the camera to 'zoom out'.
Changing to a larger value, such as 2, will cause the camera to 'zoom in'.</p>
<p>A value of 1 means 'no zoom' and is the default.</p>
<p>Changing the zoom does not impact the Camera viewport in any way, it is only applied during rendering.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>value</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    1
                
                </td>
            

            <td class="description last"><p>The zoom value of the Camera. The minimum it can be is 0.001.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#setZoom">Phaser.Cameras.Scene2D.BaseCamera#setZoom</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L1387">Line 1387</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This Camera instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="shake"><span class="type-signature"></span>shake( [duration] [, intensity] [, force] [, callback] [, context])</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Shakes the Camera by the given intensity over the duration specified.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>duration</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    100
                
                </td>
            

            <td class="description last"><p>The duration of the effect in milliseconds.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>intensity</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>
|

<span class="param-type"><a href="Phaser.Math.Vector2.html">Phaser.Math.Vector2</a></span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    0.05
                
                </td>
            

            <td class="description last"><p>The intensity of the shake.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>force</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    false
                
                </td>
            

            <td class="description last"><p>Force the shake effect to start immediately, even if already running.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>callback</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>This callback will be invoked every frame for the duration of the effect.
It is sent two arguments: A reference to the camera and a progress amount between 0 and 1 indicating how complete the effect is.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>context</code></td>
            

            <td class="type">
            
                
<span class="param-type">any</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js">src/cameras/2d/Camera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js#L649">Line 649</a>)</dt>
	

	

	

	
</dl>


    

    
    <h5>Fires:</h5>
    <ul>
        <li><a href="Phaser.Cameras.Scene2D.Events.html#event:SHAKE_START">Phaser.Cameras.Scene2D.Events#event:SHAKE_START</a></li>
    
        <li><a href="Phaser.Cameras.Scene2D.Events.html#event:SHAKE_COMPLETE">Phaser.Cameras.Scene2D.Events#event:SHAKE_COMPLETE</a></li>
    </ul>
    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This Camera instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="shutdown"><span class="type-signature"></span>shutdown()</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Removes all listeners.</p>
    </div>
    

    

    

    
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Events.EventEmitter.html#shutdown">Phaser.Events.EventEmitter#shutdown</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/events/EventEmitter.js">src/events/EventEmitter.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/events/EventEmitter.js#L31">Line 31</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="startFollow"><span class="type-signature"></span>startFollow(target [, roundPixels] [, lerpX] [, lerpY] [, offsetX] [, offsetY])</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Sets the Camera to follow a Game Object.</p>
<p>When enabled the Camera will automatically adjust its scroll position to keep the target Game Object
in its center.</p>
<p>You can set the linear interpolation value used in the follow code.
Use low lerp values (such as 0.1) to automatically smooth the camera motion.</p>
<p>If you find you're getting a slight &quot;jitter&quot; effect when following an object it's probably to do with sub-pixel
rendering of the targets position. This can be rounded by setting the <code>roundPixels</code> argument to <code>true</code> to
force full pixel rounding rendering. Note that this can still be broken if you have specified a non-integer zoom
value on the camera. So be sure to keep the camera zoom to integers.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>target</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Phaser.GameObjects.GameObject.html">Phaser.GameObjects.GameObject</a></span>
|

<span class="param-type">object</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>The target for the Camera to follow.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>roundPixels</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    false
                
                </td>
            

            <td class="description last"><p>Round the camera position to whole integers to avoid sub-pixel rendering?</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>lerpX</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    1
                
                </td>
            

            <td class="description last"><p>A value between 0 and 1. This value specifies the amount of linear interpolation to use when horizontally tracking the target. The closer the value to 1, the faster the camera will track.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>lerpY</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    1
                
                </td>
            

            <td class="description last"><p>A value between 0 and 1. This value specifies the amount of linear interpolation to use when vertically tracking the target. The closer the value to 1, the faster the camera will track.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>offsetX</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    0
                
                </td>
            

            <td class="description last"><p>The horizontal offset from the camera follow target.x position.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>offsetY</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    0
                
                </td>
            

            <td class="description last"><p>The vertical offset from the camera follow target.y position.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js">src/cameras/2d/Camera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js#L900">Line 900</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This Camera instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="stopFollow"><span class="type-signature"></span>stopFollow()</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Stops a Camera from following a Game Object, if previously set via <code>Camera.startFollow</code>.</p>
    </div>
    

    

    

    
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js">src/cameras/2d/Camera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js#L965">Line 965</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This Camera instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="toggleFlipX"><span class="type-signature"></span>toggleFlipX()</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Toggles the horizontal flipped state of this Game Object.</p>
<p>A Game Object that is flipped horizontally will render inversed on the horizontal axis.
Flipping always takes place from the middle of the texture and does not impact the scale value.
If this Game Object has a physics body, it will not change the body. This is a rendering toggle only.</p>
    </div>
    

    

    

    
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.GameObjects.Components.Flip.html#toggleFlipX">Phaser.GameObjects.Components.Flip#toggleFlipX</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/gameobjects/components/Flip.js">src/gameobjects/components/Flip.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/gameobjects/components/Flip.js#L45">Line 45</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This Game Object instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="toggleFlipY"><span class="type-signature"></span>toggleFlipY()</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Toggles the vertical flipped state of this Game Object.</p>
    </div>
    

    

    

    
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.GameObjects.Components.Flip.html#toggleFlipY">Phaser.GameObjects.Components.Flip#toggleFlipY</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/gameobjects/components/Flip.js">src/gameobjects/components/Flip.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/gameobjects/components/Flip.js#L64">Line 64</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This Game Object instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="toJSON"><span class="type-signature"></span>toJSON()</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Returns an Object suitable for JSON storage containing all of the Camera viewport and rendering properties.</p>
    </div>
    

    

    

    
    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	
	<dt class="inherited-from method-doc-label method-doc-details-label">Inherited From:</dt>
	<dd class="inherited-from">
		<ul class="dummy">
			<li>
				<a href="Phaser.Cameras.Scene2D.BaseCamera.html#toJSON">Phaser.Cameras.Scene2D.BaseCamera#toJSON</a>
			</li>
		</ul>
	</dd>
	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js">src/cameras/2d/BaseCamera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/BaseCamera.js#L1488">Line 1488</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>A well-formed object suitable for conversion to JSON.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Types.Cameras.Scene2D.html#.JSONCamera">Phaser.Types.Cameras.Scene2D.JSONCamera</a></span>



    </dd>
</dl>


        

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="update"><span class="type-signature">&lt;protected> </span>update(time, delta)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Internal method called automatically by the Camera Manager.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>time</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>



            
            </td>

            

            

            <td class="description last"><p>The current timestamp as generated by the Request Animation Frame or SetTimeout.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>delta</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>



            
            </td>

            

            

            <td class="description last"><p>The delta time, in ms, elapsed since the last frame.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.0.0</dt>
	

	

    
    <dt class="tag-overrides">Overrides:</dt>
    <dd class="tag-overrides"><ul class="dummy"><li>
        <a href="Phaser.Cameras.Scene2D.BaseCamera.html#update">Phaser.Cameras.Scene2D.BaseCamera#update</a>
    </li></ul></dd>
    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js">src/cameras/2d/Camera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js#L1000">Line 1000</a>)</dt>
	

	

	

	
</dl>


    

    

    

    

    

    

    
</dd>

        
            
<hr>
<dt>
    <h4 class="name" id="zoomTo"><span class="type-signature"></span>zoomTo(zoom [, duration] [, ease] [, force] [, callback] [, context])</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>This effect will zoom the Camera to the given scale, over the duration and with the ease specified.</p>
    </div>
    

    

    

    
    
        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Argument</th>
        

        
        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>zoom</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>



            
            </td>

            
                <td class="attributes">
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>The target Camera zoom value.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>duration</code></td>
            

            <td class="type">
            
                
<span class="param-type">integer</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    1000
                
                </td>
            

            <td class="description last"><p>The duration of the effect in milliseconds.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>ease</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>
|

<span class="param-type">function</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    'Linear'
                
                </td>
            

            <td class="description last"><p>The ease to use for the pan. Can be any of the Phaser Easing constants or a custom function.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>force</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                    false
                
                </td>
            

            <td class="description last"><p>Force the pan effect to start immediately, even if already running.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>callback</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Phaser.Types.Cameras.Scene2D.html#.CameraPanCallback">Phaser.Types.Cameras.Scene2D.CameraPanCallback</a></span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>This callback will be invoked every frame for the duration of the effect.
It is sent four arguments: A reference to the camera, a progress amount between 0 and 1 indicating how complete the effect is,
the current camera scroll x coordinate and the current camera scroll y coordinate.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>context</code></td>
            

            <td class="type">
            
                
<span class="param-type">any</span>



            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                

                
                </td>
            

            
                <td class="default">
                
                </td>
            

            <td class="description last"><p>The context in which the callback is invoked. Defaults to the Scene to which the Camera belongs.</p></td>
        </tr>

    
    </tbody>
</table>

    

    
<dl class="details">
    

	

	
	<dt class="tag-since method-doc-label method-doc-details-label">Since: 3.11.0</dt>
	

	

    

    

    

    

	

	

	

	

	



	
	<dt class="tag-source method-doc-label method-doc-details-label">Source: <a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js">src/cameras/2d/Camera.js</a> (<a href="https://github.com/photonstorm/phaser/tree/v3.22.0/src/cameras/2d/Camera.js#L721">Line 721</a>)</dt>
	

	

	

	
</dl>


    

    
    <h5>Fires:</h5>
    <ul>
        <li><a href="Phaser.Cameras.Scene2D.Events.html#event:ZOOM_START">Phaser.Cameras.Scene2D.Events#event:ZOOM_START</a></li>
    
        <li><a href="Phaser.Cameras.Scene2D.Events.html#event:ZOOM_COMPLETE">Phaser.Cameras.Scene2D.Events#event:ZOOM_COMPLETE</a></li>
    </ul>
    

    

    

    

    
    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>This Camera instance.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Phaser.Cameras.Scene2D.Camera.html">Phaser.Cameras.Scene2D.Camera</a></span>



    </dd>
</dl>


        

    
</dd>

        </dl>
    

    

    
</article>

</section>




		</div>
	</div>

	<div class="clearfix"></div>

	
		<div class="col-md-3">
			<div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
		</div>
	

</div>
</div>


    <div class="modal fade" id="searchResults">
      <div class="modal-dialog">
        <div class="modal-content">
          <div class="modal-header">
            <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>
            <h4 class="modal-title">Search results</h4>
          </div>
          <div class="modal-body"></div>
          <div class="modal-footer">
            <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
          </div>
        </div><!-- /.modal-content -->
      </div><!-- /.modal-dialog -->
    </div>


<footer>

    <div align="center" style="margin-bottom: 32px">

        <img src="img/phaser3-logo.png" alt="Phaser 3 Logo" title="Phaser 3" /><br />

        <p>Please <a href="https://phaser.io/community/donate">support Phaser development</a> via Patreon or PayPal.</p>

        <p>Found an error in the docs? <a href="https://github.com/photonstorm/phaser/issues">Open an issue</a> and let us know where!</p>

    </div>


	<span class="copyright">
	Phaser Copyright © 2020 Photon Storm Ltd and the contributors to the Phaser projects.
	</span>

<span class="jsdoc-message">
	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a>
	
		on July 13th 2020, 4:20:51 pm
	
	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
</footer>

<script src="scripts/docstrap.lib.js"></script>
<script src="scripts/toc.js"></script>

    <script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>


<script>
$( function () {
	$( "[id*='$']" ).each( function () {
		var $this = $( this );

		$this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
	} );

	$( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
		var $this = $( this );

		var example = $this.find( "code" );
		exampleText = example.html();
		var lang = /{@lang (.*?)}/.exec( exampleText );
		if ( lang && lang[1] ) {
			exampleText = exampleText.replace( lang[0], "" );
			example.html( exampleText );
			lang = lang[1];
		} else {
			var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
			lang = langClassMatch ? langClassMatch[1] : "javascript";
		}

		if ( lang ) {

			$this
			.addClass( "sunlight-highlight-" + lang )
			.addClass( "linenums" )
			.html( example.html() );

		}
	} );

	Sunlight.highlightAll( {
		lineNumbers : true,
		showMenu : true,
		enableDoclinks : true
	} );

	$.catchAnchorLinks( {
        navbarOffset: 10
	} );
	$( "#toc" ).toc( {
		anchorName  : function ( i, heading, prefix ) {
			return $( heading ).attr( "id" ) || ( prefix + i );
		},
		selectors   : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
		showAndHide : false,
		smoothScrolling: true
	} );

	$( "#main span[id^='toc']" ).addClass( "toc-shim" );
	$( '.dropdown-toggle' ).dropdown();

    $( "table" ).each( function () {
      var $this = $( this );
      $this.addClass('table');
    } );

} );
</script>



<!--Navigation and Symbol Display-->


<!--Google Analytics-->

<script>
	(function ( i, s, o, g, r, a, m ) {
		i['GoogleAnalyticsObject'] = r;
		i[r] = i[r] || function () {
			(i[r].q = i[r].q || []).push( arguments )
		}, i[r].l = 1 * new Date();
		a = s.createElement( o ),
			m = s.getElementsByTagName( o )[0];
		a.async = 1;
		a.src = g;
		m.parentNode.insertBefore( a, m )
	})( window, document, 'script', '//www.google-analytics.com/analytics.js', 'ga' );

	ga( 'create', 'UA-44006568-1', 'phaser.io' );
	ga( 'send', 'pageview' );
</script>



    <script type="text/javascript">
        $(document).ready(function() {
            SearcherDisplay.init();
        });
    </script>


</body>
</html>